Rest API – User Communication

+ More

Table of Contents

Overview Retrieve User Communication Details Example: Query Parameter Descriptions Retrieve the User Communication Schema Property Descriptions Delete User Communication

How to create, update, query and delete user communications in SPM using the Fire Scope REST API.

Overview

The REST API allows you to work with User communication methods in Fire Scope SPM using a REST client in lieu of the SPM user interface. Specifically, you can:

  • Retrieve User Communication Details
  • Retrieve the User Communication Schema
  • Create or Update User Communication
  • Delete User Communication

Retrieve User Communication Details

To retrieve the current information about User Communication in SPM, send unique query parameters in a GET request to the following URL:

Example:

http://localhost:38050/web_services/...mmtypeid=Email

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, name, userid and commtypeid ) to match your environment and data.

A JSON response will be returned similar in structure to the payload for the Create or Update User Communication.

Query Parameter Descriptions

Property Description Type Required
account Name of the SPM Account. String Yes
name Contact information for the User–based on the communication type. String Yes
userid Name of the SPM User. String Yes
commtypeid Communication type–email, SMS, or Jabber. String Yes

Retrieve the User Communication Schema

To retrieve the full SPM schema for User communication, send the Account name in a GET request to the following URL:

http://[IP address]:38050/web_services/comm?account=[Account name]&schema=true

Note: Don’t forget to change the domain name ([IP address) and query parameter values (account, and schema) to match your environment and data.

Create or Update User Communication

To create or update User communication, send a POST operation with a JSON document to the following URL:

http://[IP address]:38050/web_services/comm

Note: Don’t forget to change the domain name ([IP address) to match your environment and data.

Use the following example as a guide, but note that it may not include all optional properties.

{
 "account_id": "firescope",
 "active": 0,
 "commtypeid": "Email",
 "period": "1-7,00:00-23:59",
 "sendto": "fake3@ou812.fake",
 "severity": 63,
 "userid": "fake3"
 }

Property Descriptions

Property Description Type Default Value Required
account_id Name of the SPM Account. String   Yes
active Status of the User communication settings.0 = active1 = disabled Number 0 Yes
commtypeid Communication type–email, SMS, or Jabber. String   Yes
period Time period(s) during which Notifications are sent to this User. String 1-7,00:00-23:59 Yes
sendto Specific email, SMS, or Jabber information where the communication is sent. String   Yes
severity Which types of Notifications the User will receive, based on severity. Number 63 Yes
userid Name of the SPM User. String   Yes

Delete User Communication

To delete User communication, send an HTTP DELETE request to the following URL:

http://[IPAddress]:38050/web_services/comm?account=[Accountname]&name=[Contact Information]&userid=[User Name]&commtypeid=[Communication Type]

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, name, userid, and commtypeid) to match your environment and data.

Related Articles