iMonnit - Online Wireless Sensors Portal |

How to use our APIs

Rest API allows users to integrate their sensor data into 3rd party applications. API calls can be made from programming language of your choice. Responses are served as either XML(Extensible Markup Language) or JSON (JavaScript Object Notation). Overuse could result in revocation of API portal.

Overuse Example: making the same call more often than the data is updated (Datamessage Methods: 1 request per 10 minutes). Please utilize the webhook for real time Datamessages.

*All Dates are in UTC (Universal Coordinated Time) both for the input and for the output.
*To request a larger data load, Please contact support

Authorization

APIs use authorization to ensure that client requests access data securely. The APIKeyID and the APISecretKey both need to be included as headers in the posted request.

Click Api Keys to get your API keys.

Parameters

Our parameters will need to be passed in the request as Param entries. The Parameter name will be set as the Key and the parameter value will be set as the Value.

Explore our APIs

Method: TimeZones
*Special Case: No Authorization Token Required*
Returns the list of supported timezones.

Parameters

None

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>TimeZones</Method>
  <Result xsi:type="xsd:collection">
    <APINameIDList>
      <APINameID ID="1" Name="_UTC -10 – USA – Hawaii, Honolulu" />
      <APINameID ID="2" Name="_UTC -9 – USA – Alaska, Anchorage" />
      <APINameID ID="3" Name="_UTC -8 – USA – California, Los Angeles (DST)" />
      ...
    </APINameIDList>
  </Result>
</SensorRestAPI>

Method: TimeZonesWithRegion
*Special Case: No Authorization Token Required*
Returns the list of supported timezones.

Parameters

None

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>TimeZonesWithRegion</Method>
  <Result xsi:type="xsd:collection">
    <APITimeZoneList>
      <APITimeZone ID="1" StandardName="Hawaiian Standard Time" DisplayName="USA – Hawaii, Honolulu" Region="Pacific"/>
      <APITimeZone ID="2" StandardName="Alaskan Standard Time" DisplayName="USA – Alaska, Anchorage" Region="Americas"/>
      <APITimeZone ID="3" StandardName="Pacific Standard Time" DisplayName="USA – California, Los Angeles (DST)" Region="Pacific"/>
      ...
    </APITimeZoneList>
  </Result>
</SensorRestAPI>

Method: SMSCarriers
*Special Case: No Authorization Token Required*
Returns the list of supported SMS Carriers.

Parameters

None

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SMSCarriers</Method>
  <Result xsi:type="xsd:collection">
    <APINameIDList>
      <APINameID ID="1" Name="Alltel" />
      <APINameID ID="2" Name="AT&T" />
      <APINameID ID="3" Name="Boost Mobile" />
      ...
    </APINameIDList>
  </Result>
</SensorRestAPI>

Method: GetApplicationID
*Special Case: No Authorization Token Required*
Returns the list of supported Application Names and Id's.

Parameters

None

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GetApplicationID</Method>
  <Result xsi:type="xsd:collection">
    <APINameIDList>
      <APINameID ID="1" Name="Analog Voltage" />
      <APINameID ID="2" Name="Temperature" />
      ...
    </APINameIDList>
  </Result>
</SensorRestAPI>

Method: GetDatumByType
*Special Case: No Authorization Token Required*
Returns the list of datums by application type.

Parameters

ApplicationID:

Long

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GetDatumByType</Method>
  <Result xsi:type="xsd:collection">
    </APIDatumTypeList>
      <DatumID="2" Name="Temperature" Index="0"/>
    </APIDatumTypeList>
  </Result>
</SensorRestAPI>

Method: Check account number is unique.

Parameters

accountNumber:

string

Desired Account Number

Example

Example Outputs

<SensorRestAPI>
  <Method>AccountNumberAvailable</Method>
  <Result xsi:type="xsd:string">Account Number: APIUser Test is unavailable</Result>
</SensorRestAPI>

<SensorRestAPI>
  <Method>AccountNumberAvailable</Method>
  <Result xsi:type="xsd:string">true</Result>
</SensorRestAPI>

Method: Check username is unique.

Parameters

username:

string

Desired username

Example

Example Outputs

<SensorRestAPI>
  <Method>UserNameAvailable</Method>
  <Result xsi:type="xsd:string">username: APIUser Test is unavailable</Result>
</SensorRestAPI>

<SensorRestAPI>
  <Method>UserNameAvailable</Method>
  <Result xsi:type="xsd:string">true</Result>
</SensorRestAPI>

Method: Check notification email is unique.

Parameters

notificationEmail:

string

Desired Notification Email

Example

Example Outputs

<SensorRestAPI>
  <Method>NotificationEmailAvailable</Method>
  <Result xsi:type="xsd:string">NotificationEmailAvailable: API is unavailable</Result>
</SensorRestAPI>

<SensorRestAPI>
  <Method>NotificationEmailAvailable</Method>
  <Result xsi:type="xsd:string">true</Result>
</SensorRestAPI>

Method: SensorLookUp
Returns the Sensor meta data.

Parameters

sensorID:	Integer	Unique identifier of the sensor
CheckDigit:	String	Check digit to prevent unauthorized access to sensors

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorLookUp</Method>
  <Result xsi:type="xsd:collection">
      <APISensorMetaData ApplicationID="2" SensorID="1234" FirmwareVersion="2.5.4.3" PowerSourceID="1" RadioBand="900 MHz" Calibration1="0" Calibration2="100000" Calibration3="560000" Calibration4="10000" GenerationType="Gen1" />
  </Result>
</SensorRestAPI>

Method: GatewayLookUp
Returns the Gateway meta data.

Parameters

GatewayID:	Integer	Unique identifier of the Gateway
CheckDigit:	String	Check digit to prevent unauthorized access to Gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayLookUp</Method>
  <Result xsi:type="xsd:collection">
      <APIGatewayMetaData  GatewayID="1234"  GatewayTypeID="2" RadioBand="900 MHz" APNFirmwareVersion="2.5.1.2" GatewayFirmwareVersion="3.3.0.2" GenerationType="Gen1" />
  </Result>
</SensorRestAPI>

Method: CalibrationFacilityList
*Special Case: No Authorization Token Required*
Lookup to Find CalibrationFacilityID

Parameters

None

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CalibrationFacilityList</Method>
  <Result xsi:type="xsd:collection">
    <APICalibrationFacilityList>
      <APICalibrationFacility CalibrationFacilityID="1" Name="CalLabCo"/>
      <APICalibrationFacility CalibrationFacilityID="2" Name="KWJ Engineering"/>
      <APICalibrationFacility CalibrationFacilityID="3" Name="Laboratory Testing"/>
      <APICalibrationFacility CalibrationFacilityID="4" Name="Custom Facility"/>
    </APICalibrationFacilityList>
  </Result>
</SensorRestAPI>

Method: CreateAccount
*Special Case: No Authorization Token Required*
Creates a new account

Parameters

CompanyName:	string	Company Name / Account Number used to lookup account
TimeZoneID:	integer	Identifier of the timezone to view sensor data
Address:	string	Street address for account
Address2:	string (optional)	Second line of street address for account
City:	string	City for account
State:	string	State or Region for account
PostalCode:	string	Postal Code for account
Country:	string	Country for account
ResellerID:	Integer (optional)	Identifier of reseller where hardware was purchased
UserName:	string	Username for primary contact to log into system
Password:	string	Password for primary contact to log into system
ConfirmPassword:	string	Confirmation of password for primary contact to log into system
FirstName:	string	First name of primary contact
LastName:	string	Last name of primary contact
NotificationEmail:	string	Email address of primary contact
NotificationPhone:	string (optional)	Cell phone number to receive sms notifications
SMSCarrierID:	integer (optional)	Identifier of cell phone carrier to receive sms notifications

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateAccount</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>
------------------------------------------------------------------------------------------------------------------
<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateAccount</Method>
  <Result xsi:type="xsd:collection">
    <APIValidationErrorList>
      <APIValidationError Parameter="CompanyName" Error="Company name already exists"/>
      <APIValidationError Parameter="UserName" Error="Username not available"/>
    </APIValidationErrorList>
  </Result>
</SensorRestAPI>

Method: AccountGet
Returns account Object.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountGet</Method>
  <Result xsi:type="xsd:collection"">
    <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestUser" ParentID="1"  ExpirationDate="4/7/2017 12:00:00 AM"/>/>
  </Result>
</SensorRestAPI>

Method: EditAccountInformation
Edit Account Information

Parameters

accountID:	long	Account Number
AccountNumber:	string (optional)	CompanyName/Account Number used to lookup account
CompanyName:	string (optional)	Company Name / Account Number used to lookup account
TimeZoneID:	long (optional)	Identifier of the timezone to view sensor data
Address:	string (optional)	Street address for account
Address2:	string (optional)	Second line of street address for account
City:	string (optional)	City for account
State:	string (optional)	State or Region for account
PostalCode:	string (optional)	Postal Code for account
Country:	string (optional)	Country for account
BusinessTypeID:	long (optional)	Business Type
IndustryTypeID:	long (optional)	Industry Type of the Business
PrimaryContactID:	long (optional)	CustomerId of the customer you want to be the Primary Contact for the account.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>EditAccountInformation</Method>
  <Result xsi:type="xsd:string">Successfully Saved</Result>
</SensorRestAPI>

Method: EditCustomerInformation
Edit Customer Information

Parameters

custID:	long	Customer Number
FirstName:	string (optional)	Customers First Name
LastName:	string (optional)	Customers Last Name
NotificationEmail:	string (optional)	Customers email to send notifications
NotificationPhone:	string (optional)	Customers Phone number to send notifications
SMSCarrierID:	long (optional)	SMS Carrier Account ID used to change carriers

Example

Example Outputs

	<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>EditCustomerInformation</Method>
  <Result xsi:type="xsd:string">Successfully Saved</Result>
</SensorRestAPI>

Method: GetCustomerPermissions
Returns customer permissions

Parameters

custID:

long

Unique identifier of customer

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GetCustomerPermissions</Method>
  <Result xsi:type="xsd:collection">
    <APIPermissionList>
      <APIPermission Name="Customer_Edit_Other" Can="False"/>
      <APIPermission Name="Customer_Edit_Self" Can="True"/>
       ...
    </APIPermissionList>
  </Result>
</SensorRestAPI>

Method: EditCustomerPermissions
Edit Customer Permissions

Parameters

custID:	long	Customer Number
Customer_Create:	bool (optional)	Add User
Network_View_Net_{networkID}:	bool (optional)	Can See Network. NetworkID is the ID of the network you want the user to either be able to view or not view. example (Network_View_Net_123=off). you can add or remove multiple networks at the same time by using different networkIDs.
Customer_Delete:	bool (optional)	Delete Users
Notification_Disable_Network:	bool (optional)	Disable Rules from Network
Account_Edit:	bool (optional)	Edit Account
Network_Edit_Gateway_Settings:	bool (optional)	Edit Gateway Configuration
Network_Edit:	bool (optional)	Edit Network
Notification_Edit:	bool (optional)	Edit Rules
Customer_Edit_Other:	bool (optional)	Edit Other Users
Customer_Edit_Self:	bool (optional)	Edit Self
Sensor_Edit:	bool (optional)	Edit Sensor
Sensor_Configure_Multiple:	bool (optional)	Edit Sensor (Mulitple)
Visual_Map_Edit:	bool (optional)	Modify Visual Map
Customer_Reset_Password_Other:	bool (optional)	Reset Other User Password
Sensor_Calibrate:	bool (optional)	Calibrate Sensor
Sensor_Export_Data:	bool (optional)	Export Data
Sensor_View_Chart:	bool (optional)	View Charts
Navigation_View_Maps:	bool (optional)	View Maps
Navigation_View_My_Account:	bool (optional)	View My Account
Sensor_View_Notifications:	bool (optional)	View Rules
Navigation_View_Reports:	bool (optional)	View Reports
Sensor_View_History:	bool (optional)	View Sensor History
Network_Create:	bool (optional)	Add Network
Sensor_Advanced_Configuration:	bool (optional)	Edit Sensor (Advanced)
Sensor_Heartbeat_Restriction:	bool (optional)	Limit Sensor Heartbeat
Customer_Change_Username:	bool (optional)	Edit Usernames
Unlock_User:	bool (optional)	Password Unlock
Sensor_Group_Edit:	bool (optional)	Edit Sensor Group
Show_Dashboard:	bool (optional)	Show Dashboard
Notification_Pause:	bool (optional)	Pause Rules
Navigation_View_API:	bool (optional)	View API
Notification_Can_Acknowledge:	bool (optional)	Acknowledge Rules
Customer_Can_Update_Firmware:	bool (optional)	Firmware Update Allowed
Account_View:	bool (optional)	View Locations
Can_Access_Billing:	bool (optional)	Can Access Billing pages
Can_Create_Certificate:	bool (optional)	Can Create Calibration Certificate

Example

Example Outputs

 style="border: solid 1px black; background-color: #DDEEFF; padding: 5px; overflow: auto;max-width:835px;">
    <?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>EditCustomerPermissions</Method>
  <Result xsi:type="xsd:string">Successfully Saved</Result>
</SensorRestAPI>

Method: Retrieve Username
*Special Case: No Authorization Token Required*
Sends an email with your username to the email address provided.

Parameters

email:

string

Email address for the desired username.

Example

Example Outputs

<SensorRestAPI>
  <Method>RetrieveUsername</Method>
  <Result xsi:type="xsd:string">Sent email to me@mywebsite.com</Result>
</SensorRestAPI>

Method: CreateAccountUser

Parameters

UserName:	string	Username for primary contact to log into system
FirstName:	string	First name of primary contact
LastName:	string	Last name of primary contact
Password:	string	Password for primary contact to log into system
ConfirmPassword:	string	Confirmation of password for primary contact to log into system
NotificationEmail:	string	Email address of primary contact
IsAdmin:	Boolean	If User will have Administration abilities
Title:	string (optional)	Users Title (Mr,Mrs,Dr etc..)
ReceivesMaintenanceBySMS:	Boolean (optional)	If User will receive Maintenance informatiton by text
ReceivesMaintenanceByEmail:	Boolean (optional)	If User will receive Maintenance informatiton by Email
ReceivesNotificationsBySMS	Boolean (optional)	If User will receive Notifications by text
ReceivesNotificationsByVoice:	Boolean (optional)	If User will receive Notifications by Phone
NotificationPhone:	string (optional)	Cell phone number to receive sms notifications
NotificationPhone2:	string (optional)	Cell phone number to receive Voice notifications
SMSCarrierID:	integer (optional)	Identifier of cell phone carrier to receive sms notifications
accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateAccountUser</Method>
  <Result xsi:type="xsd:collection">
  <APIUser UserID="1" Title="Mr" FirstName="John" LastName="Dough" EmailAddress="Invalid@invlaid.com" SMSNumber="+1 555-555-555" VoiceNumber="+1 555-555-555" DirectSMS="False" ReceivesNotificationsBySMS="False" ReceivesNotificationsByVoice="True" Active="True" Admin="True" ReceivesMaintenanceByEmail="True" ReceivesMaintenanceBySMS="False" ExternalSMSProviderID="1" UserName="JohnDoughUser"/>>
  </Result>
</SensorRestAPI>
------------------------------------------------------------------------------------------------------------------
<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateAccountUser</Method>
  <Result xsi:type="xsd:collection">
    <APIValidationErrorList>
      <APIValidationError Parameter="UserName" Error="Username not available"/>
    </APIValidationErrorList>
  </Result>
</SensorRestAPI>

Method: AccountUserDelete
Removes the user from the account.

Parameters

userID:

Integer

Unique identifier of the user

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountUserDelete</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: AccountUserList
Returns all users on the specified account

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountUserList</Method>
  <Result xsi:type="xsd:collection">
    <APIUserList>
      <APIUser UserID="554" UserName="john.doe" Name="John Doe" EmailAddress="jdoe@someserver.com" SMSNumber="5555555551" ReceivesNotificationsBySMS="true" DirectSMS="true" ExternalSMSProviderID="1" VoiceNumber=5555555552"" RecievesNotificaitonsByVoice="true" Active="true" Admin="true" RecievesMaintenanceByEmail="true" RecievesMaintenanceBySMS="true"  AccountID="101"/>
      <APIUser UserID="556" UserName="jane.doe" Name="Jane Doe" EmailAddress="jdoe1@someserver.com" SMSNumber="5555555553" ReceivesNotificationsBySMS="true" DirectSMS="false" ExternalSMSProviderID="0" VoiceNumber=5555555554"" RecievesNotificaitonsByVoice="false" Active="true" Admin="false" RecievesMaintenanceByEmail="false" RecievesMaintenanceBySMS="false"  AccountID="101"/>
    </APIUserList>
  </Result>
</SensorRestAPI>

Method: AccountUserGet
Returns the user object.

Parameters

userID:

Integer

Unique identifier of the user

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountUserGet</Method>
  <Result xsi:type="xsd:collection">
  <APIUser UserID="1" Title="Mr" FirstName="John" LastName="Dough" EmailAddress="Invalid@invlaid.com" SMSNumber="+1 555-555-555" VoiceNumber="+1 555-555-555" DirectSMS="False" ReceivesNotificationsBySMS="False" ReceivesNotificationsByVoice="True" Active="True" Admin="True" ReceivesMaintenanceByEmail="True" ReceivesMaintenanceBySMS="False" ExternalSMSProviderID="1" UserName="JohnDoughUser" AccountID="123"/>>
  </Result>
</SensorRestAPI>

Method: AccountUserEdit
Edit User Information

Parameters

userID:	long	Customer Number
FirstName:	string (optional)	Customers First Name
LastName:	string (optional)	Customers Last Name
NotificationEmail:	string (optional)	Customers email to send notifications
NotificationPhone:	string (optional)	Customers Phone number to send notifications
NotificationPhone2:	string (optional)	Customers Phone number to send Voice notifications
Title:	string (optional)	Users Title (Mr,Mrs,Dr etc..)
ReceivesMaintenanceBySMS:	Boolean (optional)	If User will receive Maintenance informatiton by text
ReceivesMaintenanceByEmail:	Boolean (optional)	If User will receive Maintenance informatiton by Email
ReceivesNotificationsBySMS	Boolean (optional)	If User will receive Notifications by text
ReceivesNotificationsByVoice:	Boolean (optional)	If User will receive Notifications by Phone
SMSCarrierID:	long (optional)	SMS Carrier Account ID used to change carriers

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateAccountUser</Method>
  <Result xsi:type="xsd:collection">
  <APIUser UserID="1" Title="Mr" FirstName="John" LastName="Dough" EmailAddress="Invalid@invlaid.com" SMSNumber="+1 555-555-555" VoiceNumber="+1 555-555-555" DirectSMS="False" ReceivesNotificationsBySMS="False" ReceivesNotificationsByVoice="True" Active="True" Admin="True" ReceivesMaintenanceByEmail="True" ReceivesMaintenanceBySMS="False" ExternalSMSProviderID="1" UserName="JohnDoughUser"/>>
  </Result>
</SensorRestAPI>

Method: AccountUserScheduleGet
Get Notification schedule for a User

Parameters

userID:

Integer

Unique identifier of the user

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountUserScheduleGet</Method>
  <Result xsi:type="xsd:collection">
    <APIUserNotificationScheduleList>
      <APIUserNotificationSchedule DayOfWeek="Monday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="All_Day"/>
      <APIUserNotificationSchedule DayOfWeek="Tuesday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="After"/>
      <APIUserNotificationSchedule DayOfWeek="Wednesday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="Before"/>
      <APIUserNotificationSchedule DayOfWeek="Thursday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="Before_and_After"/>
      <APIUserNotificationSchedule DayOfWeek="Friday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="Between"/>
      <APIUserNotificationSchedule DayOfWeek="Saturday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="Off"/>
      <APIUserNotificationSchedule DayOfWeek="Sunday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="Off"/>
    </APIUserNotificationScheduleList>
  </Result>
</SensorRestAPI>

Method: AccountUserScheduleSet
Set Notification schedule for a User by day

Parameters

userID:	Integer	Unique identifier of the user
day:	String	Day of the Week
notificationSchedule:	String:	Off, All_Day, After, Before, Before_and_After, Between
firstEnteredTime:	Timespan	Time of day designation
secondEnteredTime:	Timespan	Time of day designation

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountUserScheduleSet</Method>
  <Result xsi:type="xsd:string">
    <APIUserNotificationScheduleList>
      <APINotificationSchedule DayOfWeek="Monday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="All_Day"/>
    </APIUserNotificationScheduleList>
  </Result>
</SensorRestAPI>

Method: CreateSubAccount
Creates a new account

Parameters

CompanyName:	string	Company Name used to lookup account
AccountNumber:	string (optional)	Account Number for internal use will default to CompanyName if not provided
IsPremium:	boolean (optional)	Determines if new account receives premiere subscription
TimeZoneID:	integer	Identifier of the timezone to view sensor data
Address:	string	Street address for account
Address2:	string (optional)	Second line of street address for account
City:	string	City for account
State:	string	State or Region for account
PostalCode:	string	Postal Code for account
Country:	string	Country for account
parentID:	Integer (optional)	The ID of the account that this new subaccount will be under
UserName:	string	User name for primary contact to log into system
Password:	string	Password for primary contact to log into system
ConfirmPassword:	string	Confirmation of password for primary contact to log into system
FirstName:	string	First name of primary contact
LastName:	string	Last name of primary contact
NotificationEmail:	string	Email address of primary contact
NotificationPhone:	string (optional)	Cell phone number to receive sms notifications
SMSCarrierID:	integer (optional)	Identifier of cell phone carrier to receive sms notifications
IsAdmin:	boolean (optional)	Determines if new account will have Administrative privileges. Defaults to true if ommited

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateSubAccount</Method>
  <Result xsi:type="xsd:collection">
     <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestUser" ParentID="1"  ExpirationDate="4/7/2018 12:00:00 AM"/>/>
  </Result>
</SensorRestAPI>
------------------------------------------------------------------------------------------------------------------
<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateSubAccount</Method>
  <Result xsi:type="xsd:collection">
    <APIValidationErrorList>
      <APIValidationError Parameter="CompanyName" Error="Company name already exists"/>
      <APIValidationError Parameter="UserName" Error="Username not available"/>
    </APIValidationErrorList>
  </Result>
</SensorRestAPI>

Method: RemoveSubAccount
Removes the account from the system.

Parameters

accountID:

Integer

Unique identifier of the account

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RemoveSubAccount</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SubAccountList
Returns the list of account that are sub accounts to the calling users account.

Parameters

Name:	String (optional)	Filters list to account with account number, company name, contact names containing this string. (case-insensitive)
accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SubAccountList</Method>
  <Result xsi:type="xsd:collection">
  <APIAccountList>
    <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestCompany" ParentID="1"/>
    <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestCompany" ParentID="1"/>
  <APIAccountList>
  </Result>
</SensorRestAPI>

Method: SubAccountTreeList
Returns the list of account trees that are sub accounts to the calling users account.

Parameters

accountID:

Integer

Unique identifier of SubAccount.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SubAccountTreeList</Method>
  <Result xsi:type="xsd:collection">
  <APIAccountTreeList>
    <APIAccountTree  AccountID="3" AccountName="Account3" ParentID="12" AccountIDTree="|1|3|"/>
    <APIAccountTree  AccountID="5" AccountName="Account5" ParentID="3" AccountIDTree="|1|3|5|" />
  <APIAccountTreeList>
  </Result>
</SensorRestAPI>

Method: AccountParentEdit
Edit Account Parent

Parameters

accountID:	Integer	The Account Number of your account.
parentID:	long	The Account Number of the desired account.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountParentEdit</Method>
  <Result xsi:type="xsd:collection"">
    <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestUser" ParentID="14"  ExpirationDate="4/7/2017 12:00:00 AM"/>/>
  </Result>
</SensorRestAPI>

Method: Reseller Password Reset
Resets the password of the user with userid, if that account is owned by the requesting reseller.

Parameters

userID:	int	id of the user whose password you would like to reset
NewPassword:	string	New password for the given account

Example

Example Outputs

<SensorRestAPI>
  <Method>ResellerPasswordReset</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SetExpirationDate
Adds 1 year of premium subscription to an account

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Outputs

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SetExpirationDate</Method>
  <Result xsi:type="xsd:collection"">
    <APIAccount PrimaryContactID="1234" AccountID="12345" AccountNumber="Corporate" CompanyName="TestCompany" Address="7304 South Cottonwood" Address2="Suite 240" City="Midvale" PostalCode="85047" State="UT" Country="USA" BusinessTypeID="1" IndustryTypeID="2" TimeZoneID="4" PrimaryContact="TestUser" ParentID="1"  ExpirationDate="4/7/2018 12:00:00 AM"/>/>
  </Result>
</SensorRestAPI>

Method: RecentResellerNotification
Returns recently generated notifications for all sub-accounts

Parameters

minutes:	Integer	Number of minutes past Notifications will be returned
lastSentNotificationID	Integer (optional)	Only returns Notifications received after this notification ID

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RecentResellerNotification</Method>
  <Result xsi:type="xsd:string">
    <APISentNotificationList>
      <APISentNotification SentNotificationID="554" NotificationID="228" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 100 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Over 100" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Alarming"  AcknowledgedBy="" AcknowledgedByID="-1" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="556" NotificationID="229" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 32 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Under 32" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Armed"  AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="560" NotificationID="230" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 10 degrees Farh.</p>" Content="Temperature is over 10 degrees Farh." Name="Temp - 101 Over 10" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Acknowledged" AcknowledgedBy="John Doe" AcknowledgedByID="1234" AcknowledgedTime="12/14/2018 6:17:17 PM" AcknowledgeMethod="Browser_MainList" ResetTime="12/14/2018 6:17:29 PM"/>
      <APISentNotification SentNotificationID="561" NotificationID="239" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 12 degrees Farh.</p>" Content="Temperature is over 12 degrees Farh." Name="Temp - 101 Under 12" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Not Active" AcknowledgedBy="System_Auto" AcknowledgedByID="0" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
    </APISentNotificationList>
  </Result>
</SensorRestAPI>

Method: CreateNetwork
Adds new wireless sensor network to account

Parameters

Name:

String

Name of network to be added

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateNetwork</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: CreateNetwork2
Adds new wireless sensor network to account

Parameters

Name:	String	Name of network to be added
ExternalAccessUntil:	DateTime (optional)	how long the install guide should be able to access data from that network.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CreateNetwork2</Method>
  <Result xsi:type="xsd:collection">
    <APINetwork NetworkID="100" NetworkName="New Network Name" SendNotifications="True" ExternalAccessUntil="2016/2/2" />
  </Result>
</SensorRestAPI>

Method: RemoveNetwork()
Removes the network from the system.

Parameters

networkID:

Integer

Unique identifier of the network

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RemoveNetwork</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NetworkList
Returns the list of networks that belong to user.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NetworkList</Method>
  <Result xsi:type="xsd:collection">
    <APINetworkList>
      <APINetwork NetworkID="100" NetworkName="OfficeNetwork" SendNotifications="False" />
      <APINetwork NetworkID="300" NetworkName="Warehouse" SendNofitications="True" />
    </APINetworkList>
  </Result>
</SensorRestAPI>

Method: GatewayResetDefaults()
Removes the gateway object from the network and resets it back to factory defaults.

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayResetDefaults</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

GatewayReform

Method: GatewayReform()
Reform updates the sensors list for the gateway and changes the channel of the gateway. .

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayReform</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: RemoveGateway()
Removes the gateway object from the network.

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RemoveGateway</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

AssignGateway

Method: AssignGateway
Assigns gateway to the specified network

Parameters

NetworkID:	Integer	Identifier of network on your account
GatewayID:	Integer	Identifier of gateway to move
CheckDigit:	String	Check digit to prevent unauthorized movement of gateways

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AssignGateway</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

GatewayGet

Method: GatewayGet
Returns the gateway object.

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayGet</Method>
  <Result xsi:type="xsd:collection">
  <APIGateway GatewayID="1234" NetworkID="100" Name="(103) gateway" GatewayType="Ethernet_Gateway" Heartbeat="5" IsDirty="False" LastCommunicationDate="1/11/2011 2:57:36 PM" LastInboundIPAddress="" MacAddress="" IsUnlocked="False" CheckDigit="XXXX" AccountID="123"  SignalStrength="31" BatteryLevel="84" ResetInterval="168" GatwayPowerMode="Force_High_Power"/> />
  </Result>
</SensorRestAPI>

GatewayList

Method: GatewayList
Returns the list of gateways that belongs to user.

Parameters

Name:	String (optional)	Filters list to gateways with names containing this string. (case-insensitive)
NetworkID:	Integer (optional)	Filters list to gateway that belong to this network id
accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayList</Method>
  <Result xsi:type="xsd:collection">
    <APIGatewayList>
      <APIGateway GatewayID="2599" NetworkID="100" Name="Building2 (103) gateway" GatewayType="Ethernet_Gateway" Heartbeat="5" IsDirty="False" LastCommunicationDate="1/11/2011 2:57:36 PM" LastInboundIPAddress="" MacAddress="123456789|3123456789" IsUnlocked="False" CheckDigit="XXXX" AccountID="123" SignalStrength="31" BatteryLevel="84" />
      <APIGateway GatewayID="100" NetworkID="100" Name="Building3 (Gateway) 100" GatewayType="usb" Heartbeat="5" IsDirty="False" LastCommunicationDate="2/6/2011 4:30:44 PM" LastInboundIPAddress=""  MacAddress="123456789|3123456789" IsUnlocked="False" CheckDigit="XXXX" AccountID="123" SignalStrength="31" BatteryLevel="84"  />
      <APIGateway GatewayID="901" NetworkID="100" Name="WiFi Gateway(WIFI ActiveID) Building1" GatewayType="Wifi_Sensor" Heartbeat="15" IsDirty="True" LastCommunicationDate="2/6/2011 4:18:40 PM" LastInboundIPAddress=""  MacAddress="123456789|3123456789" IsUnlocked="False" CheckDigit="XXXX" AccountID="123" SignalStrength="31" BatteryLevel="84"  />
    </APIGatewayList>
  </Result>
</SensorRestAPI>

Method: GatewaySetHeartbeat
Sets the heartbeat intervals of the Gateway

Parameters

gatewayID:	Integer	Unique identifier of the gateway
reportInterval:	Numeric	Standard state heart beat

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewaySetHeartbeat</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: GatewaySetIP

Set the IP address, Subnet Mask, Default Gateway, and DNS Server of a gateway.

Parameters

GatewayID:	Integer	Unique identifier of the gateway.
IPAddress:	String	This is the IP address assigned to the gateway. Setting the IP address to 0.0.0.0 will force the gateway to use DHCP.
NetworkMask:	String	This is the Subnet ID of the network.
DefaultGateway:	String	IP address of the default router.
DNSServer:	String	This is the IP address of the DNS server to use.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewaySetIP</Method>
  <Result xsi:type="xsd:string">New host set after pending command.</Result>
</SensorRestAPI>

Method: GatewaySetName
Sets the display name of the gateway

Parameters

gatewayID:	Integer	Unique identifier of the gateway
gatewayName:	String	Name to give the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewaySetName</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

GatewayPoint

Method: GatewayPoint
Sets the host address and port of a gateway.

Parameters

GatewayID:	Integer	Unique identifier of the gateway
HostAddress:	String	Address of the host server.
Port:	Integer	Port of the host server.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayPoint</Method>
  <Result xsi:type="xsd:string">Set pending command.</Result>
</SensorRestAPI>

Method: GatewaySetHost
*Special Case: No Authorization Token Required*
Set the host address and port of a gateway.

Parameters

GatewayID:	Integer	Unique identifier of the gateway
CheckDigit:	String	Check digit to prevent unauthorized movement of gateways
HostAddress:	String	Address of the host server.
Port:	Integer	Port of the host server.
LockDirty:	Bool	Force the gateway to always send config when talking to "this" server.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewaySetHost</Method>
  <Result xsi:type="xsd:string">New host set after pending command.</Result>
</SensorRestAPI>

GatewayClearHost

Method: GatewayClearHost
*Special Case: No Authorization Token Required*
Resets the host address and port of a gateway to factory defaults.

Parameters

GatewayID:	Integer	Unique identifier of the gateway
CheckDigit:	String	Check digit to prevent unauthorized movement of gateways

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayClearHost</Method>
  <Result xsi:type="xsd:string">Host reset to default after pending command.</Result>
</SensorRestAPI>

GatewayCellNetworkConfig

Method: GatewayCellNetworkConfig
Sets APN settings of a gateway. You may include or omit arguments as desired, except for the GatewayID.

Parameters

GatewayID:	Integer	Unique identifier of the gateway
CellAPNName:	String	APN Name for the Gateway.
Username:	String	APN username for the Gateway.
Password:	String	APN password for the Gateway.
GatewayDNS:	String	Primary DNS.
SecondaryDNS:	String	Secondary DNS.
PollInterval:	Double	Interval for gateway communication to keep connection open.
GPSReportInterval:	Double	Interval for gateway to send its location

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayCellNetworkConfig</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

GatewayAutoConfig

Method: GatewayAutoConfig
Sets a pending command for the gateway to go into AutoConfig Mode for the number of minutes specifies. If the number of minutes is not provided, the gateway's stored value will be used.

Parameters

gatewayID:	Integer	Unique identifier of the gateway
AutoConfigTime:	Integer	Number of minutes the gateway will be in AutoConfig mode.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayAutoConfig</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: GatewayStopAutoConfig
Sets a pending command to end autoconfig mode the next time the gateway communicates with the server.

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayStopAutoConfig</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: GatewayUpdateFirmware
Updates the firmware of gateway

Parameters

gatewayID:

Integer

Unique identifier of the gateway

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayUpdateFirmware</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorResetDefaults()
Removes the sensor object from the network and sets the sensor back to factory defaults.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorResetDefaults</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: RemoveSensor()
Removes the sensor object from the network.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RemoveSensor</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: AssignSensor
Assigns sensor to the specified network

Parameters

NetworkID:	Integer	Identifier of network on your account
SensorID:	Integer	Identifier of sensor to move
CheckDigit:	String	Check digit to prevent unauthorized movement of sensors

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AssignSensor</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorGet
Returns the sensor object.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGet</Method>
  <Result xsi:type="xsd:string"><APISensor SensorID="101" ApplicationID="2" CSNetID="100" SensorName="Room3_Ceiling" LastCommunicationDate="6/1/2011 4:09:41 PM" NextCommunicationDate="6/13/2011 6:11:41 PM" LastDataMessageID="1" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="122° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="True" CheckDigit="IMABCD" MonnitApplicationID="2" /></Result>
</SensorRestAPI>

Method: SensorGetExtended
Returns the sensor object with extended Properties.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGetExtended</Method>
  <Result xsi:type="xsd:string"><APISensorExteded ReportInterval="0" ActiveStateInterval="0" InactivityAlert="0" MeasurementsPerTransmission="0" MinimumThreshold="0" MaximumThreshold="0" Hysteresis="0" SensorID="101" ApplicationID="2" CSNetID="100" SensorName="Temp 101" LastCommunicationDate="6/20/2011 6:36:23 PM" NextCommunicationDate="6/29/2011 8:38:23 PM" LastDataMessageID="230" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="86° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="False" CheckDigit="XXXX" AccountID="1234" MonnitApplicationID="2" TransmitOffset="0"  Recovery="3" /> /></Result>
</SensorRestAPI>

Method: SensorApplicationIDGet
Returns the application identifier of the sensor.

Parameters

SensorID:	interger	Unique identifier of the sensor
CheckDigit:	String (optional)	Check Digit required if sensor not already on your account

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorApplicationIDGet</Method>
  <Result xsi:type="xsd:string">2</Result>
</SensorRestAPI>

Method: SensorNameGet
Returns the application identifier of the sensor.

Parameters

SensorID:	interger	Unique identifier of the sensor
CheckDigit:	String (optional)	Check Digit required if sensor not already on your account

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorNameGet</Method>
  <Result xsi:type="xsd:string">Temperature 101</Result>
</SensorRestAPI>

Method: SensorList
Returns the list of sensors that belongs to user.

Parameters

Name:	String (optional)	Filters list to sensors with names containing this string. (case-insensitive)
NetworkID:	Integer (optional)	Filters list to sensor that belong to this network id
ApplicationID:	Integer (optional)	Filters list to sensor that are this application type
Status:	Integer (optional)	Filters list to sensor that match this status
accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorList</Method>
  <Result xsi:type="xsd:collection">
    <APISensorList>
      <APISensor SensorID="101" ApplicationID="2" CSNetID="100" SensorName="Room3_Ceiling" LastCommunicationDate="6/1/2011 4:09:41 PM" NextCommunicationDate="6/13/2011 6:11:41 PM" LastDataMessageID="1" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="122° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="True" CheckDigit="IMABCD" AccountID="1234" MonnitApplicationID="2" />
      <APISensor SensorID="102" ApplicationID="2" CSNetID="100" SensorName="Room3_Floor" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 12:01:00 AM" LastDataMessageID="-9223372036854775808" PowerSourceID="1" Status="4" CanUpdate="True" CurrentReading="No Reading Available" BatteryLevel="100" SignalStrength="100" AlertsActive="True" CheckDigit="IMBCDE" AccountID="1234" MonnitApplicationID="2" />
      <APISensor SensorID="10" ApplicationID="2" CSNetID="100" SensorName="Room3_Door" LastCommunicationDate="6/1/2011 5:21:08 PM" NextCommunicationDate="6/13/2011 7:23:08 PM" LastDataMessageID="218" PowerSourceID="1" Status="1" CanUpdate="False" CurrentReading="-1767.8° F" BatteryLevel="100" SignalStrength="-59" AlertsActive="True"  CheckDigit="IMDCEF" AccountID="1234" MonnitApplicationID="2" />
    </APISensorList>
  </Result>
</SensorRestAPI>

SensorListFull

Method: SensorListFull
Returns the list of sensors that belongs to user.

Parameters

Name:	String (optional)	Filters list to sensors with names containing this string. (case-insensitive)
NetworkID:	Integer (optional)	Filters list to sensor that belong to this network id
ApplicationID:	Integer (optional)	Filters list to sensor that are this application type
Status:	Integer (optional)	Filters list to sensor that match this status
accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorListFull</Method>
  <Result xsi:type="xsd:collection">
    <APISensorListFull>
      <APISensorFull ReportInterval="0" ActiveStateInterval="0" InactivityAlert="0" MeasurementsPerTransmission="0" MinimumThreshold="0" MaximumThreshold="0" Hysteresis="0" SensorID="101" ApplicationID="2" CSNetID="100" SensorName="Room3_Ceiling" LastCommunicationDate="6/1/2011 4:09:41 PM" NextCommunicationDate="6/13/2011 6:11:41 PM" LastDataMessageID="1" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="122° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="True" CheckDigit="IMBCDE" AccountID="1234" ApplicationID="2" />
      <APISensorFull ReportInterval="0" ActiveStateInterval="0" InactivityAlert="0" MeasurementsPerTransmission="0" MinimumThreshold="0" MaximumThreshold="0" Hysteresis="0" SensorID="102" ApplicationID="2" CSNetID="100" SensorName="Room3_Floor" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 12:01:00 AM" LastDataMessageID="-9223372036854775808" PowerSourceID="1" Status="4" CanUpdate="True" CurrentReading="No Reading Available" BatteryLevel="100" SignalStrength="100" AlertsActive="True" CheckDigit="IMEXTD" AccountID="1234" ApplicationID="2" />
      <APISensorFull ReportInterval="0" ActiveStateInterval="0" InactivityAlert="0" MeasurementsPerTransmission="0" MinimumThreshold="0" MaximumThreshold="0" Hysteresis="0" SensorID="10" ApplicationID="2" CSNetID="100" SensorName="Room3_Door" LastCommunicationDate="6/1/2011 5:21:08 PM" NextCommunicationDate="6/13/2011 7:23:08 PM" LastDataMessageID="218" PowerSourceID="1" Status="1" CanUpdate="False" CurrentReading="-1767.8° F" BatteryLevel="100" SignalStrength="-59" AlertsActive="True" CheckDigit="IMFGHI" AccountID="1234" ApplicationID="2" />
    </APISensorListFull>
  </Result>
</SensorRestAPI>

Method: NetworkIDFromSensorGet
Returns the network that the sensor belongs to.

Parameters

SensorID:	interger	Unique identifier of the sensor
CheckDigit:	String (optional)	Check Digit required if sensor not already on your account

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NetworkIDFromSensorGet</Method>
  <Result xsi:type="xsd:string">100</Result>
</SensorRestAPI>

Method: SensorSetHeartbeat
Sets the heartbeat intervals of the sensor. Heartbeats cannot be set to lower than 10 minutes

Parameters

sensorID:	Integer	Unique identifier of the sensor
reportInterval:	Numeric	Standard state heart beat (Minimum 10 minutes)
activeStateInterval:	Numeric	Aware state heart beat (Minimum of 10 minutes. Must be equal to or less than reportInterval)

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetHeartbeat</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSetIP

Set the IP address, Subnet Mask, Default Gateway, and DNS Server of a Sensor.

Parameters

SensorID:	Integer	Unique identifier of the Sensor.
IPAddress:	String	This is the IP address assigned to the sensor. Setting the IP address to 0.0.0.0 will force the sensor to use DHCP.
NetworkMask:	String	This is the Subnet ID of the network.
DefaultGateway:	String	IP address of the default router.
DNSServer:	String	This is the IP address of the DNS server to use.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetIP</Method>
  <Result xsi:type="xsd:string">New host set after pending command.</Result>
</SensorRestAPI>

Method: SensorSetName
Sets the display name of the sensor

Parameters

sensorID:	Integer	Unique identifier of the sensor
sensorName:	String	Name to give the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetName</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSetThreshold
Sets the thresholds of the sensor that activate Aware State

Parameters

sensorID:	Integer	Unique identifier of the sensor
measurementsPerTransmission:	Integer	Number of times per heartbeat the thresholds are checked.
minimumThreshold:	Integer	Minimum Threshold
maximumThreshold:	Integer	Maximum Threshold
hysteresis:	Integer	Maximum Threshold

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetThreshold</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSetCalibration
Sets the calibration values of the sensor.
Calibration if different for each sensor profile (temp, light, etc.) You'll need to know what profile of sensor your calibrating. The calibration routine for any given provile will not use all of the values available. Before calling this method you should first call "SensorGetCalibration" to get the correct values for the fields you will not be changing during the calibration.

Parameters

sensorID:	Integer	Unique identifier of the sensor
calibration1:	64 bit Integer	Value used to store calibration values on sensors. (profile dependant)
calibration2:	64 bit Integer	Value used to store calibration values on sensors. (profile dependant)
calibration3:	64 bit Integer	Value used to store calibration values on sensors. (profile dependant)
calibration4:	64 bit Integer	Value used to store calibration values on sensors. (profile dependant)
eventDetectionType:	Integer	Type of event detected (profile dependant)
eventDetectionCount:	Integer	Number of events required to trigger (profile dependant)
eventDetectionPeriod:	Integer	Time window for event count to be reached (profile dependant)
rearmTime:	Integer	Time before event can be triggered again (profile dependant)
biStable:	Integer	Direction of event (profile dependant)
TransmitOffset:	Integer	In small sensor networks, the sensors can be set to synchronize their communications. The default setting off allows the sensors to randomize their communications therefore maximizing communication robustness. Setting this will synchronize the communication of the sensors. Example: Turning synchronization on all sensors indicates that they all try to communicate within 5 seconds of each other, recommended to limit this to gateways with 10 or fewer sensors.
Recovery:	Integer	Once the recovery count is reached, the sensor will go to link mode and begin scanning channels and trying to find a gateway to join
pushProfileConfig1:	boolean	Set the configuration page to be pushed to the sensor (profile dependant)
pushProfileConfig2:	boolean	Set the configuration page to be pushed to the sensor (profile dependant)
pushAutoCalibrateCommand:	boolean	Set the auto calibrate command to be pushed to the sensor (profile dependant)

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetCalibration</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorGetCalibration
Returns the sensor object with calibration properties.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

Deprecated: MonnitApplicationID. Use ApplicationID

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGetCalibration</Method>
  <Result xsi:type="xsd:collection">
   <APISensorCalibration SensorID="101" ApplicationID="2" CSNetID="1" SensorName="Temp 101" Calibration1="183" Calibration2="100000" Calibration3="560000" Calibration4="10000" EventDetectionType="-2147483648" EventDetectionPeriod="-2147483648" EventDetectionCount="-2147483648" RearmTime="0" BiStable="-2147483648" PushProfileConfig1="False" PushProfileConfig2="False" PushAutoCalibrateCommand="False" MonnitApplicationID="2" />
  </Result>
</SensorRestAPI>

Method: CalibrationCertificateList
List all callibration certificates assigned to a given sensor

Parameters

SensorID:	Integer	Identifier of sensor
ShowDeleted:	Bool	Include deleted certificates

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CalibrationCertificateList</Method>
  <Result xsi:type="xsd:collection">
    <APICalibrationCertificateList>
      <APICalibrationCertificate CalibrationCertificateID="1234" CreatedByUserID="1234" SensorID="1234" DateCreated="9/22/2022 8:22:50 PM" DateCertified="3/7/2021 12:00:00 AM" CertificationValidUntil="10/31/2022 12:00:00 AM" CalibrationNumber="No Certification ID Provided" CalibrationFacilityID="1" CertificationType="1234" DeletedByUserID="-9223372036854775808" DeletedDate="1/1/0001 12:00:00 AM" />
    </APICalibrationCertificateList>
  </Result>
</SensorRestAPI>

Method: CalibrationCertificateCreate
Create or edit a calibration certificate.

Parameters

SensorID:	Long
CableID:	Long
DateCertified:	DateTime
CertificationExpirationDate:	DateTime
CalibrationFacilityID:	Long
CalibrationNumber:	String

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>CalibrationCertificateCreate</Method>
  <Result xsi:type="xsd:collection">
    <APICalibrationCertificate CalibrationCertificateID="1234" CreatedByUserID="1234" SensorID="1234" DateCreated="10/12/2022 5:08:14 PM" DateCertified="10/12/2022 11:07:00 AM" CertificationValidUntil="10/12/2024 11:07:00 AM" CalibrationNumber="Test" CalibrationFacilityID="1234" CertificationType="" DeletedByUserID="-9223372036854775808" DeletedDate="1/1/0001 12:00:00 AM"/>
  </Result>
</SensorRestAPI>

Method: CalibrationCertificateRemove
Delete a calibration certificate and remove it from sensor

Parameters

CalibrationCertificateID:

Long

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Method>CalibrationCertificateRemove</Method>
    <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSetAlerts
Sets alerts active/inactive for network containing sensor

Parameters

sensorID:	Integer	Unique identifier of the sensor
active:	Boolean	state to set the notifications. [true \| false]

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetAlerts</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSetTag()
Sets a tag field for a sensor (No longer used)

Parameters

sensorID:	Long	Unique identifier of the Sensor
tag:	String	This is a pipe deliminated string that gives a way to group sensors

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSetTag</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorAttributes
Returns the list of attributes that belong to a sensor.

Parameters

SensorID:

interger

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorAttributes</Method>
  <Result xsi:type="xsd:collection">
    <APISensorAttributeList>
      <APISensorAttribute SensorID="101" Name="CorF" Value="C" />
    </APISensorAttributeList>
  </Result>
</SensorRestAPI>

Method: SensorAttributeSet
Creates/Updates sensor attribute.

Parameters

SensorID:	interger	Unique identifier of the sensor
Name:	string	Name of the attribute
Value:	string	Value for the attribute

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorAttributeSet</Method>
  <Result xsi:type="xsd:collection">
   <APISensorAttribute SensorID="101" Name="CorF" Value="C" />
  </Result>
</SensorRestAPI>

Method: SensorAttributeRemove
Remove attribute from sensor.

Parameters

SensorID:	interger	Unique identifier of the sensor
Name:	string	Name of the attribute

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorAttributeRemove</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorSendControlCommand
Sends a Control message

Parameters

SensorID:	Integer	Identifier of sensor to send command to
RelayIndex:	Integer	Identifier of which relay to use by index.(Relay1 = 0,Relay2 = 1)
State:	Integer	Identifier of what the relay should do (toggle = 3, on = 2, off = 1)
Seconds:	Integer	Identifier of how long after receiving the command the command should initialize

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorSendControlCommand</Method>
  <Result xsi:type="xsd:string">Control Message Successfull!! Control request will process when the sensor checks in.</Result>
</SensorRestAPI>

Method: GetDatumNameList
Returns the list of DatumNames that belongs to a sensor.

Parameters

sensorID:

Integer

Unique identifier of the sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GetDatumNameList</Method>
  <Result xsi:type="xsd:collection">
    <APIDatumNameList>
      <APIDatumName SensorID="002599" Index="0" Name="Probe1" />
      <APIDatumName SensorID="002599" Index="1" Name="Probe2" />
      <APIDatumName SensorID="002599" Index="2" Name="Probe3" />
      <APIDatumName SensorID="002599" Index="3" Name="Probe4" />
    </APIDatumNameList>
  </Result>
</SensorRestAPI>

Method: SetDatumName
Sets the datum name object.

Parameters

sensorID:	Integer	Unique identifier of the sensor
index:	Integer	unique identifier of the datum
name:	string	New name for the datum

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SetDatumName</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorGroupSensorList
Returns the sensors assigned to the sensor group.

Parameters

sensorGroupID:

Integer

Unique identifier of the sensor group

Example

Example Output

Deprecated: MonnitApplicationID. Use ApplicationID

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupSensorList</Method>
  <Result xsi:type="xsd:collection">
    <APISensorGroupSensorList>
      <APISensorGroupSensor SensorID="259" SensorGroupID="10" Position="0" ApplicationID="59" CSNetID="-9223372036854775808" SensorName="Sensor Name one" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 2:00:00 AM" LastDataMessageMessageGUID="00000000-0000-0000-0000-000000000000" PowerSourceID="1" Status="4" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="False" CheckDigit="XXXX" AccountID="4" MonnitApplicationID="59" />
      <APISensorGroupSensor SensorID="411" SensorGroupID="10" Position="1" ApplicationID="11" CSNetID="1269" SensorName="Sensor Name two " LastCommunicationDate="9/14/2016 4:22:09 PM" NextCommunicationDate="1/1/0001 12:00:00 AM" LastDataMessageMessageGUID="edf2f9c7-43b6-4bb6-a915-880c2902c4b3" PowerSourceID="1" Status="1" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="True" CheckDigit="XXXX" AccountID="1" MonnitApplicationID="11" />
      <APISensorGroupSensor SensorID="246" SensorGroupID="10" Position="6" ApplicationID="46" CSNetID="-9223372036854775808" SensorName="Sensor Name three" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 2:00:00 AM" LastDataMessageMessageGUID="00000000-0000-0000-0000-000000000000" PowerSourceID="1" Status="4" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="False" CheckDigit="XXXX" AccountID="4" MonnitApplicationID="46" />
    </APISensorGroupSensorList>
  </Result>
</SensorRestAPI>

Method: SensorGroupList
Returns an accounts sensor groups.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupList</Method>
  <Result xsi:type="xsd:collection">
    <APISensorGroupList>
      <APISensorGroup Name="My First Group" SensorGroupID="10" ParentID="29"/>
      <APISensorGroup Name="Another Sweet Group" SensorGroupID="11" ParentID="29"/>
      <APISensorGroup Name="another great group" SensorGroupID="15" ParentID="29"/>
      <APISensorGroup Name="test group" SensorGroupID="17" ParentID="null"/>
    </APISensorGroupList>
  </Result>
</SensorRestAPI>

Method: SensorGroupCreate
Create or Edit a sensor group

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
Name:	String	Name to give the Group
sensorGroupID:	Integer (optional)	Unique identifier of the sensor group. If included, group will be edited
ParentID:	Integer (optional)	Unique identifier of the sensor group Parent.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupCreate</Method>
  <Result xsi:type="xsd:collection">
    <APISensorGroup>
      <APISensorGroup Name="My group 3" SensorGroupID="18"  ParentID="29"/>
  </Result>
</SensorRestAPI>

Method: SensorGroupDelete
Deletes the requested sensor group.

Parameters

sensorGroupID:

Integer

Unique identifier of the sensor group

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupSensorList</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorGroupAssignSensor
Assigns a sensor to a sensor group, or edits its position

Parameters

sensorID:	Integer	Unique identifier of the sensor
GroupID:	Integer	Unique identifier of the sensor group
position:	Integer (optional)	Position of the sensor in the sensor group

Example

Example Output

Deprecated: MonnitApplicationID. Use ApplicationID

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupSensorList</Method>
  <Result xsi:type="xsd:collection">
    <APISensorGroupSensorList>
      <APISensorGroupSensor  SensorID="259" SensorGroupID="10" Position="0" ApplicationID="59" CSNetID="-9223372036854775808" SensorName="Sensor Name one" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 2:00:00 AM" LastDataMessageMessageGUID="00000000-0000-0000-0000-000000000000" PowerSourceID="1" Status="4" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="False" CheckDigit="XXXX" AccountID="4" MonnitApplicationID="59" />
      <APISensorGroupSensor SensorID="411" SensorGroupID="10" Position="0" ApplicationID="11" CSNetID="1269" SensorName="Sensor Name two " LastCommunicationDate="9/14/2016 4:22:09 PM" NextCommunicationDate="1/1/0001 12:00:00 AM" LastDataMessageMessageGUID="edf2f9c7-43b6-4bb6-a915-880c2902c4b3" PowerSourceID="1" Status="1" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="True" CheckDigit="XXXX" AccountID="1" MonnitApplicationID="11" />
      <APISensorGroupSensor SensorID="246" SensorGroupID="10" Position="0" ApplicationID="46" CSNetID="-9223372036854775808" SensorName="Sensor Name three" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 2:00:00 AM" LastDataMessageMessageGUID="00000000-0000-0000-0000-000000000000" PowerSourceID="1" Status="4" CanUpdate="True" BatteryLevel="0" SignalStrength="0" AlertsActive="False" CheckDigit="XXXX" AccountID="4" MonnitApplicationID="46" />
    </APISensorGroupSensorList>
  </Result>
</SensorRestAPI>

Method: SensorGroupRemoveSensor
Removes the requested sensor from a specified sensor group.

Parameters

sensorID:	Integer	Unique identifier of the sensor
GroupID:	Integer	Unique identifier of the sensor group

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorGroupRemoveSensor</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: SensorDataMessages
Returns data points recorded in a range of time (limited to a 7 day window)
*Maximum of 5000 Datapoints returned.

Parameters

sensorID:	Integer	Unique identifier of the sensor
fromDate:	Date	Start of range from which messages will be returned
toDate:	Date	End of range from which messages will be returned

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorDataMessages</Method>
  <Result xsi:type="xsd:string">
    <APIDataMessageList>
      <APIDataMessage SensorID="101" MessageDate="1/1/2011 6:36:00 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="30" DisplayData="86° F" PlotValue="86" MetNotificationRequirements="False" GatewayID="1234"/>
      <APIDataMessage  SensorID="101" MessageDate="1/1/2011 6:34:33 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="50" DisplayData="122° F" PlotValue="122" MetNotificationRequirements="False" GatewayID="1234"/>
    </APIDataMessageList>
  </Result>
</SensorRestAPI>

Method: GatewayMessages
Returns messages recorded in a range of time (limited to a 7 day window)
*Maximum of 5000 Datapoints returned.

Parameters

gatewayID:	Integer	Unique identifier of the Gateway
fromDate:	Date	Start of range from which messages will be returned
toDate:	Date	End of range from which messages will be returned

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayMessages</Method>
  <Result xsi:type="xsd:string">
    <APIDataMessageList>
      <APIGatewayMessage ReceivedDate="4/18/2016 6:23:30 PM" MessageCount="1" SignalStrength="0" Power="0" Battery="101" MessageType="0" GatewayID="xxxx"/>>
      <APIGatewayMessage ReceivedDate="4/18/2016 6:13:30 PM" MessageCount="1" SignalStrength="0" Power="0" Battery="101" MessageType="0" GatewayID="xxxx"/>>
    </APIDataMessageList>
  </Result>
</SensorRestAPI>

Method: AccountRecentDataMessages
Returns data points recorded in a range of time (limited to a 2 hour window)
*Maximum of 5000 Datapoints returned.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
networkID	Integer (optional)	Unique identifier of the network
minutes:	Integer	Number of minutes past messages will be returned
lastDataMessageGUID:	GUID (optional)	Only return messages received after this message ID

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountRecentDataMessages</Method>
  <Result xsi:type="xsd:string">
    <APIDataMessageList>
      <APIDataMessage  AccountID="101" MessageDate="1/1/2011 6:36:00 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="30" DisplayData="86° F" PlotValue="86" MetNotificationRequirements="False" GatewayID="1234"/>
      <APIDataMessage AccountID="101" MessageDate="1/1/2011 6:34:33 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="50" DisplayData="122° F" PlotValue="122" MetNotificationRequirements="False" GatewayID="1234"/>
    </APIDataMessageList>
  </Result>
</SensorRestAPI>

Method: SensorRecentDataMessages
Returns data points recorded in a range of time (limited to a 1 day window)
*Maximum of 5000 Datapoints returned.

This service is changing! "lastMessgeID" is deprecated. It will be replaced with "lastDataMessageGUID" by July 2016.

Parameters

sensorID:	Integer	Unique identifier of the sensor
minutes:	Integer	Number of minutes past messages will be returned
lastDataMessageGUID:	GUID (optional)	Only return messages received after this message ID

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorRecentDataMessages</Method>
  <Result xsi:type="xsd:string">
    <APIDataMessageList>
      <APIDataMessage SensorID="101" MessageDate="1/1/2011 6:36:00 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="30" DisplayData="86° F" PlotValue="86" MetNotificationRequirements="False" GatewayID="1234"/>
      <APIDataMessage  SensorID="101" MessageDate="1/1/2011 6:34:33 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="50" DisplayData="122° F" PlotValue="122" MetNotificationRequirements="False" GatewayID="1234"/>
    </APIDataMessageList>
  </Result>
</SensorRestAPI>

Method: AccountDataMessages
Returns data points recorded in a range of time (limited to a 7 day window)
*Maximum of 5000 Datapoints returned.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
networkID	Integer (optional)	Unique identifier of the network
fromDate:	DateTime	Start of range from which messages will be returned
toDate:	DateTime	End of range from which messages will be returned

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountDataMessages</Method>
  <Result xsi:type="xsd:string">
    <APIDataMessageList>
      <APIDataMessage  SensorID="101" MessageDate="1/1/2011 6:36:00 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="30" DisplayData="86° F" PlotValue="86" MetNotificationRequirements="False" GatewayID="1234"/>
      <APIDataMessage  SensorID="101" MessageDate="1/1/2011 6:34:33 PM" State="0" SignalStrength="-36" Voltage="3.1" Battery="100" Data="50" DisplayData="122° F" PlotValue="122" MetNotificationRequirements="False" GatewayID="1234"/>
    </APIDataMessageList>
  </Result>
</SensorRestAPI>

Method: SensorChartMessages
Returns chartable data points recorded in a range of time
Interval Sensors: (Temperature, Humidity, etc) datapoints with in the given range.
Active ID Sensors: return the number of recorded checkins by date.
Triggered Sensors: (Open/Closed,Water, etc) return a count by date of the messages that were in the "Aware" state.

*Maximum of 75 Datapoints returned. If dataset returns more than 75 datapoints every n^th datapoint (Calculated by Modulous of total datapoints divided by 75) is returned.

Parameters

sensorID:	Integer	Unique identifier of the sensor
fromDate:	Date	Start of range from which messages will be returned
toDate:	Date	End of range from which messages will be returned

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorChartMessages</Method>
  <Result xsi:type="xsd:string">
    <APIChartDataPointList>
      <APIChartDataPoint Date="1/1/2011 6:36:00 PM" Value="30" SentNotification="True"/>
      <APIChartDataPoint Date="1/1/2011 6:34:33 PM" Value="50" SentNotification="True"/>
    </APIChartDataPointList>
  </Result>
</SensorRestAPI>

Method: RecentlySentNotifications
Returns notifications recorded in a range of time (limited to a 12 hour window)

Parameters

minutes:

Integer

Number of minutes past Notifications will be returned

Optional Parameters

LastSentNotificationID	Long	Limits notification results to notifications sent after this ID
SensorID	Long	Limits which sensor notifications will come back. If this field is left null it will bring back all notifications for all sensors.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RecentlySentNotifications</Method>
  <Result xsi:type="xsd:string">
    <APISentNotificationList>
      <APISentNotification SentNotificationID="554" NotificationID="228" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 100 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Over 100" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Alarming"  AcknowledgedBy="" AcknowledgedByID="-1" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="556" NotificationID="229" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 32 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Under 32" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Armed"  AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="560" NotificationID="230" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 10 degrees Farh.</p>" Content="Temperature is over 10 degrees Farh." Name="Temp - 101 Over 10" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Acknowledged" AcknowledgedBy="John Doe" AcknowledgedByID="1234" AcknowledgedTime="12/14/2018 6:17:17 PM" AcknowledgeMethod="Browser_MainList" ResetTime="12/14/2018 6:17:29 PM"/>
      <APISentNotification SentNotificationID="561" NotificationID="239" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 12 degrees Farh.</p>" Content="Temperature is over 12 degrees Farh." Name="Temp - 101 Under 12" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Not Active" AcknowledgedBy="System_Auto" AcknowledgedByID="0" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
    </APISentNotificationList>
  </Result>
</SensorRestAPI>

Method: SentNotifications
Returns data points recorded in a range of time (limited to 7 days and 5000 records)

Parameters

from	DateTime	from is the starting point of the time period for your date range of notifications sent
to	DateTime	to is the ending point of the time period for your date range for notifications sent

Optional Parameters

SensorID

Long

Limits which sensor notifications will come back. If this field is left null it will bring back all notifications for all sensors.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>RecentlySentNotifications</Method>
  <Result xsi:type="xsd:string">
    <APISentNotificationList>
      <APISentNotification SentNotificationID="554" NotificationID="228" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 100 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Over 100" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Alarming"  AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="556" NotificationID="229" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 32 degrees Farh.</p>" Content="Temperature is over 100 degrees Farh." Name="Temp - 101 Under 32" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Armed"  AcknowledgedBy="" AcknowledgedByID="-1" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APISentNotification SentNotificationID="560" NotificationID="230" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is over 10 degrees Farh.</p>" Content="Temperature is over 10 degrees Farh." Name="Temp - 101 Over 10" Delivered="Email Sent" NotificationDate="1/1/2011 6:36:00 PM" NotificationStatus="Acknowledged" AcknowledgedBy="John Doe" AcknowledgedByID="1234" AcknowledgedTime="12/14/2018 6:17:17 PM" AcknowledgeMethod="Browser_MainList" ResetTime="12/14/2018 6:17:29 PM"/>
      <APISentNotification SentNotificationID="561" NotificationID="239" UserID="10" SensorID="101" GatewayID="0" Text="<p>Temperature is under 12 degrees Farh.</p>" Content="Temperature is over 12 degrees Farh." Name="Temp - 101 Under 12" Delivered="Email Sent" NotificationDate="1/1/2011 6:46:00 PM" NotificationStatus="Not Active" AcknowledgedBy="System_Auto" AcknowledgedByID="0" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
    </APISentNotificationList>
  </Result>
</SensorRestAPI>

Method: NotificationRecipientList
Returns all recipients on the specified notification.

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRecipientList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationRecipientList>
      <APINotificationRecipient UserID="554" Type="Email" DelayMinutes="15" RecipientID="1562"/>
      <APINotificationRecipient UserID="556" Type="SMS" DelayMinutes="15" RecipientID="1563"/>
    </APINotificationRecipientList>
  </Result>
</SensorRestAPI>

Method: NotificationSystemActionList
Return all system actions on the specified rule

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationSystemActionList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationSystemActionList>
      <APINotificationSystemAction SystemActionRecipientID="1580" ActionName="Acknowledge" TargetNotificationID="543" DelayMinutes="0" />
      <APINotificationSystemAction SystemActionRecipientID="1581" ActionName="Reset" TargetNotificationID="544" DelayMinutes="0" />
    </APINotificationSystemActionList>
  </Result>
</SensorRestAPI>

Method: NotificationControlUnitList
Returns all Control Units on the specified notification

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationControlUnitList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationControlUnitList>
      <APINotificationControlUnit ControlUnitRecipientID="1496" Relay1State="Off" Relay1Time="0 Seconds" Relay2State="Inactive" Relay2Time="NULL"/>
      <APINotificationControlUnit ControlUnitRecipientID="1581" Relay1State="Off" Relay1Time="90 Seconds" Relay2State="" Relay2Time="0 Seconds" />
      <APINotificationControlUnit ControlUnitRecipientID="1582" Relay1State="Inactive" Relay1Time="NULL" Relay2State="On" Relay2Time="60 Seconds" />
    </APINotificationControlUnitList>
  </Result>
</SensorRestAPI>

Method: NotificationLocalNotifierList
Returns all Local Notifiers on the specified notification.

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationLocalNotifierList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationLocalNotifierUnitList>
      <APINotificationLocalNotifier LocalNotifierRecipientID="1586" LED_ON="True" Buzzer_ON="True" AutoScroll_ON="False" BackLight_ON="False" />
      <APINotificationLocalNotifier LocalNotifierRecipientID="1587" LED_ON="True" Buzzer_ON="True" AutoScroll_ON="True" BackLight_ON="True" />
    </APINotificationLocalNotifierUnitList>
  </Result>
</SensorRestAPI>

Method: SensorAssignedToNotificaiton
Returns the list of sensors that belongs to user based on the notification they are assigned to.

Parameters

notificationID:

Long

Filters list to sensors that belong to this notification id

Example

Only sensors that contain a notification id of 3 are returned

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorAssignedToNotificaiton</Method>
  <Result xsi:type="xsd:collection">
    <APISensorList>
      <APISensor SensorID="101" ApplicationID="2" CSNetID="100" SensorName="Room3_Ceiling" LastCommunicationDate="6/1/2011 4:09:41 PM" NextCommunicationDate="6/13/2011 6:11:41 PM" LastDataMessageID="1" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="122° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="True" MonnitApplicationID="2" />
      <APISensor SensorID="102" ApplicationID="2" CSNetID="100" SensorName="Room3_Floor" LastCommunicationDate="1/1/2099 12:00:00 AM" NextCommunicationDate="1/1/2099 12:01:00 AM" LastDataMessageID="-9223372036854775808" PowerSourceID="1" Status="4" CanUpdate="True" CurrentReading="No Reading Available" BatteryLevel="100" SignalStrength="100" AlertsActive="True" MonnitApplicationID="2" />
      <APISensor SensorID="10"  ApplicationID="2" CSNetID="100" SensorName="Room3_Door" LastCommunicationDate="6/1/2011 5:21:08 PM" NextCommunicationDate="6/13/2011 7:23:08 PM" LastDataMessageID="218" PowerSourceID="1" Status="1" CanUpdate="False" CurrentReading="-1767.8° F" BatteryLevel="100" SignalStrength="-59" AlertsActive="True" MonnitApplicationID="2" />
    </APISensorList>
  </Result>
</SensorRestAPI>

Method: GatewayAssignedToNotificaiton
Returns the list of Gateways that belongs to user based on the notification they are assigned to.

Parameters

notificationID:

Long

Filters list to Gateways that belong to this notification id

Example

Only gateways that contain a notification id of 3 are returned

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>GatewayAssignedToNotificaiton</Method>
  <Result xsi:type="xsd:collection">
    <APIGatewayList>
      <APIGateway GatewayID="2599" NetworkID="100" Name="Building2 (103) gateway" GatewayType="Ethernet_Gateway" Heartbeat="5" IsDirty="False" LastCommunicationDate="1/11/2011 2:57:36 PM" LastInboundIPAddress="" />
      <APIGateway GatewayID="100" NetworkID="100" Name="Building3 (Gateway) 100" GatewayType="usb" Heartbeat="5" IsDirty="False" LastCommunicationDate="2/6/2011 4:30:44 PM" LastInboundIPAddress="" />
      <APIGateway GatewayID="901" NetworkID="100" Name="WiFi Gateway(WIFI ActiveID) Building1" GatewayType="Wifi_Sensor" Heartbeat="15" IsDirty="True" LastCommunicationDate="2/6/2011 4:18:40 PM" LastInboundIPAddress="" />
    </APIGatewayList>
  </Result>
</SensorRestAPI>

Method: ToggleNotification()
sets the Notification active or inactive

Parameters

notificationID:	Long	Unique identifier of the Notification
on:	Bool	on flag that sets the notification on or off based off its value

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>ToggleNotification</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: AccountNotificationList
Return all notifications on the specified account

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AccountNotificationList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationList>
      <APINotification NotificationID="519" Name="inactivity test" Subject="inactivity test" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Greater_Than" Theshold="3" Scale="" Snooze="0" LastDateSent="8/31/2016 7:35:03 PM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Inactivity" Status="Armed"  AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APINotification NotificationID="457" Name="test1" Subject="test1" Text="test1" SMSText="" VoiceText="" AccountID="1" Active="True" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Low_Battery" Status="Alarming" AcknowledgedBy="" AcknowledgedByID="-1" AcknowledgedTime="12/14/2018 6:17:17 PM" AcknowledgeMethod="Browser_MainList" ResetTime="12/14/2018 6:17:29 PM" />
      <APINotification NotificationID="458" Name="test2" Subject="test2" Text="test2" SMSText="" VoiceText="" AccountID="1" Active="True" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Application" Status="Acknowledged" AcknowledgedBy="John Doe" AcknowledgedByID="1234" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
      <APINotification NotificationID="459" Name="test3" Subject="test3" Text="test3" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Application" Status="Not Active" AcknowledgedBy="System_Auto" AcknowledgedByID="0" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
    </APINotificationList>
  </Result>
</SensorRestAPI>

Method: SensorNotificationList
Returns all notifications of the specified Sensor

Parameters

sensorID:

Long

Brings back a list of all notifications of a specific sensor

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>SensorNotificationList</Method>
  <Result xsi:type="xsd:string">
    <APINotificationList>
      <APINotification NotificationID="519" Name="inactivity test" Subject="inactivity test" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Greater_Than" Theshold="3" Scale="" Snooze="0" LastDateSent="8/31/2016 7:35:03 PM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Inactivity" Status="Armed"  AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
      <APINotification NotificationID="457" Name="test1" Subject="test1" Text="test1" SMSText="" VoiceText="" AccountID="1" Active="True" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Low_Battery" Status="Alarming" AcknowledgedBy="" AcknowledgedByID="-1" AcknowledgedTime="12/14/2018 6:17:17 PM" AcknowledgeMethod="Browser_MainList" ResetTime="12/14/2018 6:17:29 PM" />
      <APINotification NotificationID="458" Name="test2" Subject="test2" Text="test2" SMSText="" VoiceText="" AccountID="1" Active="True" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Application" Status="Acknowledged" AcknowledgedBy="John Doe" AcknowledgedByID="1234" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
      <APINotification NotificationID="459" Name="test3" Subject="test3" Text="test3" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="False" Comparer="Less_Than" Theshold="95" Scale="" Snooze="60" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Application" Status="Not Active" AcknowledgedBy="System_Auto" AcknowledgedByID="0" AcknowledgedTime="9/24/2018 6:17:15 PM" AcknowledgeMethod="System_Auto" ResetTime="9/24/2018 6:17:15 PM" />
    </APINotificationList>
  </Result>
</SensorRestAPI>

Method: NotificationScheduleList
Returns a list of Schedules for a specific notification

Parameters

notificationID:

Long

Brings back a list of all the daily schedules for the specific notification

Optional Parameters

day:

string

Brings back a single day's schedule

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationScheduleList</Method>
  <Result xsi:type="xsd:string">
    <APINotificationScheduleList>
      <APINotificationSchedule DayOfWeek="Monday" FirstEnteredTime="00:00:00" SecondEnteredTime="00:00:00" NotificationSchedule="All_Day"/>
    </APINotificationScheduleList>
  </Result>
</SensorRestAPI>

Method: NotificationDailyScheduleSet
Sets the weekly notification schedule by day

Parameters

notificationID:	Integer	Unique identifier of the Notification.
day:	String	Day of the Week
notificationSchedule:	String:	Off, All_Day, After, Before, Before_and_After, Between
firstEnteredTime:	Timespan	Time of day designation
secondEnteredTime:	Timespan	Time of day designation

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationDailyScheduleSet</Method>
  <Result xsi:type="xsd:string">
    <APIUserNotificationScheduleList>
      <APINotificationWeeklySchedule DayOfWeek="Friday" FirstEnteredTime="07:30:00" SecondEnteredTime="18:00:00" NotificationSchedule="Between"/>
    </APIUserNotificationScheduleList>
  </Result>
</SensorRestAPI>

Method: NotificationYearlyScheduleList
Get the year schedule for a notification

Parameters

notificationID:

Integer

Unique identifier of the Notification.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationYearlyScheduleList</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationYearScheduleList>
      <APINotificationYearSchedule Month="1" Day="1" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="2" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="3" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="4" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="5" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="6" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="8" SendNotifications="False"/>
      <...
      <APINotificationYearSchedule Month="12" Day="31" SendNotifications="False"/>
    </APINotificationYearScheduleList>
  </Result>
</SensorRestAPI>

Method: NotificationYearlyScheduleSet
Set the yearly schedule for a notification. Selected days will receive notifications.

Parameters

notificationID:	Integer	Unique identifier of the Notification.
Month:	Integer	Numeric value of the month of the selection ( January = 1 ... December = 12)
Days:	Integer	Numeric values of the days to NOT receive notifications. Example ( days=1\|29\|30\|31 )

*Special Case: Enter 0 for Month and Days to delete entire schedule*

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationYearlyScheduleSet</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationYearScheduleList>
      <APINotificationYearSchedule Month="1" Day="1" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="2" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="3" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="4" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="5" SendNotifications="False"/>
      <APINotificationYearSchedule Month="1" Day="6" SendNotifications="True"/>
      <APINotificationYearSchedule Month="1" Day="8" SendNotifications="False"/>
      <...
    </APINotificationYearScheduleList>
  </Result>
</SensorRestAPI>

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationYearlyScheduleSet</Method>
  <Result xsi:type="xsd:string">Notification Schedule Deleted</Result>
</SensorRestAPI>

Method: NotificationAssignSensor
Asssigns a sensor to a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
SensorID:	Long	Identifier of sensor to assign
Index:	Integer	unique identifier of the datum

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAssignSensor</Method>
  <Result xsi:type="xsd:collection">
    <APISensorList>
      <APISensor SensorID="123" ApplicationID="2" CSNetID="100" SensorName="Room3_Ceiling" LastCommunicationDate="6/1/2011 4:09:41 PM" NextCommunicationDate="6/13/2011 6:11:41 PM" LastDataMessageID="1" PowerSourceID="1" Status="1" CanUpdate="True" CurrentReading="122° F" BatteryLevel="0" SignalStrength="-36" AlertsActive="True" MonnitApplicationID="2" />
    </APISensorList>
  </Result>
</SensorRestAPI>

Method: NotificationRemoveSensor
Removes a sensor from a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
SensorID:	Long	Identifier of gateway to Remove
Index:	Integer	Unique identifier of the datum

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveSensor</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAssignGateway
Asssigns a gateway to a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
GatewayID:	Long	Identifier of gateway to assign

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAssignGateway</Method>
  <Result xsi:type="xsd:collection">
    <APIGatewayList>
      <APIGateway GatewayID="123" NetworkID="100" Name="Building2 (103) gateway" GatewayType="Ethernet_Gateway" Heartbeat="5" IsDirty="False" LastCommunicationDate="1/11/2011 2:57:36 PM" LastInboundIPAddress="" />
    </APIGatewayList>
  </Result>
</SensorRestAPI>

Method: NotificationRemoveGateway
Removes a gateway from a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
GatewayID:	Long	Identifier of gateway to Remove

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveGateway</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAssignRecipient
Asssigns a customer to receive a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
UserID:	Long	Unique identifier of user to assign
DelayMinutes:	Integer	Amount of Minutes after triggering event to alert customer.
NotificationType:	String	Method of notification delivery:(email, sms, both, or phone)

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveRecipient</Method>
  <Result xsi:type="xsd:string">
    <APINotificationRecipient>
      <APINotificationRecipient UserID="123" Type="Email" DelayMinutes="15" RecipientID="1234"/>
    </APINotificationRecipient>
  </Result>
</SensorRestAPI>

Method: NotificationRemoveRecipient
Removes a customer from a specific notification.

Parameters

RecipientID:

Long

Unique identifier of the notification's recipient

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveRecipient</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAssignSystemAction
Asssigns a system action to a specific notification.

Parameters

NotificationID:	Long	Unique identifier of the Notification
ActionType:	String	Method of system action:(Acknowledge Reset Activate Deactivate)
TargetNotificationID:	Long	Unique identifier of the target notification
DelayMinutes:	Integer	Amount of Minutes before triggering system action

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAssignSystemAction</Method>
  <Result xsi:type="xsd:collection">
      <APINotificationSystemAction SystemActionRecipientID="1554" ActionType="Reset" TargetNotificationID="456" DelayMinutes="5" />
  </Result>
</SensorRestAPI>

Method: NotificationRemoveSystemAction
Removes a system action from a specific notification.

Parameters

SystemActionRecipientID:

Long

Unique identifier of the notification's system action recipient

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveSystemAction</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAssignControlUnit
Assigns a Control Unit to the specified notification

Parameters

notificationID:	Long	Unique identifier of the Notification
DeviceID:	Long	Unique identifier of device to assign
Relay1State:	String	State of device:(Inactive On Off Toggle)
Relay2State:	String	State of device:(Inactive On Off Toggle)
Relay1Time:	Integer	Time Delay in seconds for Relay 1
Relay2Time:	Integer	Time Delay in seconds for Relay 2

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAssignControlUnit</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationControlUnit>
      <APINotificationControlUnit ControlUnitRecipientID="1496" Relay1State="Off" Relay1Time="0 Seconds" Relay2State="Inactive" Relay2Time="NULL"/>
    </APINotificationControlUnit>
  </Result>
</SensorRestAPI>

Method: NotificationRemoveControlUnit
Removes a customer from a specific notification.

Parameters

ControlUnitRecipientID:

Long

Unique identifier for that notification's control unit recipient

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveControlUnit</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAssignLocalNotifier
Assigns a local notifier to the specified notification

Parameters

notificationID:	Long	Unique identifier of the Notification
DeviceID:	Long	Unique identifier of device to assign
LED_ON:	String	State of device:(Inactive On Off Toggle)
Buzzer_ON:	String	State of device:(Inactive On Off Toggle)
AutoScroll_ON:	Integer	Time Delay in seconds for Relay 1
BackLight_ON:	Integer	Time Delay in seconds for Relay 2

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAssignLocalNotifier</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationLocalNotifier>
      <APINotificationLocalNotifier LocalNotifierRecipientID="1496" LED_ON="True" Buzzer_ON="True" AutoScroll_ON="False" BackLight_ON="False" NotifierName="Notifier AV - 213"/>
    </APINotificationLocalNotifier>
  </Result>
</SensorRestAPI>

Method: NotificationRemoveLocalNotifier
Removes a local notifier from a specific notification.

Parameters

LocalNotifierRecipientID:

Long

Unique identifier for that notification's local notifier recipient

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationRemoveLocalNotifier</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: NotificationAcknowledge
Acknowledge a desired notification.

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationAcknowledge</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationACKList>
      <APINotificationACK NotificationID="543" AcknowledgedBy="Admin Admin" AcknowledgedTime="9/26/2016 11:14:54 PM" AcknowledgeMethod="API Acknowledge" ResetTime="1/1/0001 12:00:00 AM"/>
    </APINotificationACKList>
  </Result>
</SensorRestAPI>

Method: NotificationFullReset
Acknowledge and fully reset a desired notification.

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationFullReset</Method>
  <Result xsi:type="xsd:collection">
    <APINotificationACKList>
      <APINotificationACK NotificationID="543" AcknowledgedBy="Admin Admin" AcknowledgedTime="9/26/2016 11:14:54 PM" AcknowledgeMethod="API Acknowledge" ResetTime="1/1/0001 12:00:00 AM"/>
    </APINotificationACKList>
  </Result>
</SensorRestAPI>

Method: NotificationPause
Pauses a sensor or gateway from activating a notification

Parameters

DeviceID:	Long	Unique identifier of Sensor or Gateway to assign
DeviceType:	String	Type of device:(Sensor Gateway)
Days:	Integer	Number of days from now to resume activiting notification
Hours:	Integer	Number of hours from now to resume activiting notification
Minutes:	Integer	Number of minutes from now to resume activiting notification

*Special Case: Enter 0 for days, hours, and minutes to pause indefinitely*

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationPause</Method>
  <Result xsi:type="xsd:collection">
      <APINotificationPause  DeviceID="123" DeviceType="sensor" ResumeNotifyDate="9/30/2016 12:44:22 PM" />
  </Result>
</SensorRestAPI>

Method: NotificationUnpause
UnPauses a sensor or gateway from activating a notification

Parameters

DeviceID:	Long	Unique identifier of Sensor or Gateway to assign
DeviceType:	String	Type of device:(Sensor Gateway)

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationUnpause</Method>
  <Result xsi:type="xsd:string">
      <APINotificationPause DeviceID="123" DeviceType="sensor" ResumeNotifyDate="9/30/2016 12:44:22 PM" />
  </Result>
</SensorRestAPI>

Method: NotificationDelete
Deletes a desired notification.

Parameters

notificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationDelete</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: ApplicationNotificationCreate
Create or edit a notification.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
notificationID:	Long (optional)	Unique identifier of the Notification. If included notification will be edited
Name:	String	Name of notification
Subject:	String	Text for the subject of the notification
Text:	String	Text for the body of the notification
smsText:	String	Replacement Text for the body of a SMS notification. Default text value will be used if left blank.
VoiceText:	String	Replacement Text for a voice notification. Default text value will be used if left blank.
DatumType:	string	unique identifier of the datum type ( TemperatureData or WaterDetect )
Comparer:	String	Choice for how to compare: Temperature-( Equal Greater_Than Less_Than ) Water Detect-( Equal )
threshold:	String	Temperature (Desired Temperature Integer) Water Detect(water detected = True water not detected = False)
Scale:	String	Scale of measurement ( C or F ) Water Detect(Leave blank)
Snooze:	Integer	Duration of snooze in minutes. 0 - 65535
JointSnooze:	Boolean	Sets the system to snooze all sensors attached to notification
AutoAcknowledge:	Boolean	Allows the system to acknowlege notifications that return to within its threshold

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>ApplicationNotificationCreate</Method>
  <Result xsi:type="xsd:collection">
    <APINotification>
      <APINotification NotificationID="519" Name="Temp test" Subject="Temperature test" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Greater_Than" Theshold="3" Scale="" Snooze="0" LastDateSent="8/31/2016 7:35:03 PM" DatumType="TemperatureData"  AdvancedNotificationID="-9223372036854775808" NotificationClass="Application" Status="Armed"AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
    </APINotification>
  </Result>
</SensorRestAPI>

Method: ScheduledNotificationCreate
Create or edit a Scheduled/Timed notification.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
notificationID:	Long (optional)	Unique identifier of the Notification. If included notification will be edited
Name:	String	Name of notification
Subject:	String	Text for the subject of the notification
Text:	String	Text for the body of the notification
smsText:	String	Replacement Text for the body of a SMS notification. Default text value will be used if left blank.
VoiceText:	String	Replacement Text for a voice notification. Default text value will be used if left blank.
LocalHour:	Integer	Local hour to send notification ( 0 - 23 )
LocalMinute:	Integer	Local minute to send notification ( 0 - 59 )
SensorID or GatewayID	Long (optional)	Unique identifier of the sensor or gateway. If included notification will return most recent reading

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>ScheduledNotificationCreate</Method>
  <Result xsi:type="xsd:collection">
    <APINotification>
      <APINotification NotificationID="519" Name="Scheduled test" Subject="test notification" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Equal" Theshold="16:45" Scale="" Snooze="0" LastDateSent="8/31/2016 7:35:03 PM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Timed" Status="Armed" AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM"  />
    </APINotification>
  </Result>
</SensorRestAPI>

Method: BatteryNotificationCreate
Create or edit a Low-Battery notification.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
notificationID:	Long (optional)	Unique identifier of the Notification. If included notification will be edited
Name:	String	Name of notification
Subject:	String	Text for the subject of the notification
Text:	String	Text for the body of the notification
smsText:	String	Replacement Text for the body of a SMS notification. Default text value will be used if left blank.
VoiceText:	String	Replacement Text for a voice notification. Default text value will be used if left blank.
Threshold:	String	Desired battery percentage to notify when below ( 0-100 )
Snooze:	Integer	Duration of snooze in minutes. ( 0 - 65535 )
JointSnooze:	Boolean	Sets the system to snooze all sensors attached to notification
AutoAcknowledge:	Boolean	Allows the system to acknowlege notifications that return to within its threshold

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>BatteryNotificationCreate</Method>
  <Result xsi:type="xsd:collection">
    <APINotification>
      <APINotification NotificationID="519" Name="Low_Battery test" Subject="test notification" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Equal" Theshold="15" Scale="" Snooze="120" LastDateSent="8/31/2016 7:35:03 PM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Low_Battery" Status="Armed" AcknowledgedBy="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" AcknowledgedByID="" ResetTime="1/1/0001 12:00:00 AM" />
    </APINotification>
  </Result>
</SensorRestAPI>

Method: InactivityNotificationCreate
Create or edit a notification.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
notificationID:	Long (optional)	Unique identifier of the Notification. If included notification will be edited
Name:	String	Name of notification
Subject:	String	Text for the subject of the notification
Text:	String	Text for the body of the notification
smsText:	String	Replacement Text for the body of a SMS notification. Default text value will be used if left blank.
VoiceText:	String	Replacement Text for a voice notification. Default text value will be used if left blank.
threshold:	String	Duration of time without communication in minutes ( 0 - 525600 )
Snooze:	Integer	Duration of snooze in minutes.( 0 - 65535 )
JointSnooze:	Boolean	Sets the system to snooze all sensors attached to notification
AutoAcknowledge:	Boolean	Allows the system to acknowlege notifications that return to within its threshold

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>InactivityNotificationCreate</Method>
  <Result xsi:type="xsd:collection">
    <APINotification>
      <APINotification NotificationID="519" Name="Inactivity test" Subject="test notification" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Equal" Theshold="245" Scale="" Snooze="120" LastDateSent="1/1/0001 12:00:00 AM" DatumType=""  AdvancedNotificationID="-9223372036854775808" NotificationClass="Inactivity" Status="Armed" AcknowledgedBy="" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
    </APINotification>
  </Result>
</SensorRestAPI>

Method: AdvancedNotificationCreate
Create or edit an advanced notification.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
notificationID:	Long (optional)	Unique identifier of the Notification. If included notification will be edited
AdvancedNotificationID:	Integer	Unique identifier of the advanced notification
Name:	String	Name of notification
Subject:	String	Text for the subject of the notification
Text:	String	Text for the body of the notification
smsText:	String	Replacement Text for the body of a SMS notification. Default text value will be used if left blank.
VoiceText:	String	Replacement Text for a voice notification. Default text value will be used if left blank.
Snooze:	Integer	Duration of snooze in minutes. ( 0 - 65535 )
JointSnooze:	Boolean	Sets the system to snooze all sensors attached to notification
AutoAcknowledge:	Boolean	Allows the system to acknowlege notifications that return to within its threshold

*Special Case: To set Advanced Parameters See API call "NotificationListAdvancedParameters" *

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>BatteryNotificationCreate</Method>
  <Result xsi:type="xsd:collection">
    <APINotification>
      <APINotification NotificationID="519" Name="Advanced notification test" Subject="test notification" Text="" SMSText="" VoiceText="" AccountID="1" Active="False" JointSnooze="True" AutoAcknowledge="True" Comparer="Equal" Theshold="0" Scale="" Snooze="120" LastDateSent="8/31/2016 7:35:03 PM" DatumType="" AdvancedNotificationID="1" NotificationClass="Advanced" Status="Armed" AcknowledgedBy" AcknowledgedByID="" AcknowledgedTime="1/1/0001 12:00:00 AM" AcknowledgeMethod="" ResetTime="1/1/0001 12:00:00 AM" />
    </APINotification>
  </Result>
</SensorRestAPI>

Method: NotificationListAdvancedTypes
Lists all advanced notification types

Parameters

accountID:

Integer (optional)

Unique identifier of Account. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationListAdvancedTypes</Method>
  <Result xsi:type="xsd:collection">
    <APIAdvancedNotificationList>
      <APIAdvancedNotification AdvancedNotificationID="1" Name="Notify after aware period" AllowsSensors="True" AllowsGateways="False"/>
      <APIAdvancedNotification AdvancedNotificationID="2" Name="Back Online" AllowsSensors="True" AllowsGateways="False"/>
    </APIAdvancedNotificationList>
  </Result>
</SensorRestAPI>

Method: NotificationListAdvancedParameters
Lists parameters for a desired advanced notification

Parameters

accountID:	Integer (optional)	Unique identifier of Account. If omitted, Your default account will be used.
AdvancedNotificationID:	Integer	Unique identifier of the advanced notification

*Special Case: If the returned value ParameterType is "Option". Use API call "NotificationListAdvancedParameterOption" to find values *

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationListAdvancedParameters</Method>
  <Result xsi:type="xsd:collection">
    <APIAdvancedNotificationParameterList>
      <APIAdvancedNotificationParameter AdvancedNotificationParameterID="3" ParameterType="int" Required="True" ParameterDescription="The amount of time in the sensor must not checked in before this notification will be activated on the next checkin."/>
    </APIAdvancedNotificationParameterList>
  </Result>
</SensorRestAPI>

Method: NotificationListAdvancedParameterOptions
Lists options for a desired parameter

Parameters

AdvancedNotificationParameterID:

Integer

Unique identifier of the advanced notification parameter

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>NotificationListAdvancedParameterOption</Method>
  <Result xsi:type="xsd:collection">
    <APIAdvancedNotificationParameterOptionList>
      <APIAdvancedNotificationParameterOption Description="Above" ValueToEnter="1"/>
      <APIAdvancedNotificationParameterOption Description="Below" ValueToEnter="0"/>
    </APIAdvancedNotificationParameterOptionList>
  </Result>
</SensorRestAPI>

Method: AdvancedNotificationParameterSet
Sets advanced notification parameter

Parameters

NotificationID:	Long	Unique identifier of the Notification
AdvancedNotificationParameterID:	Integer	Unique identifier of the advanced notification parameter
ParameterValue:	string	The Value to set for the parameter

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AdvancedNotificationParameterSet</Method>
  <Result xsi:type="xsd:collection">
    <APIAdvancedNotificationParameterValueList>
      <APIAdvancedNotificationParameterValue  NotificationID="596" AdvancedNotificationParameterID="19" ParameterValue="9" ParameterDescription="CompressorID"/>
    </APIAdvancedNotificationParameterValueList>
  </Result>
</SensorRestAPI>

Method: AdvancedNotificationParameterList
Lists parameters for an advanced notification

Parameters

NotificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AdvancedNotificationParameterList</Method>
  <Result xsi:type="xsd:collection">
    <APIAdvancedNotificationParameterValueList>
      <APIAdvancedNotificationParameterValue  NotificationID="123" AdvancedNotificationParameterID="9" ParameterValue="Not Aware" ParameterDescription="Trigger_When"/>
      <APIAdvancedNotificationParameterValue  NotificationID="123" AdvancedNotificationParameterID="10" ParameterValue="65" ParameterDescription="Percentage"/>
      <APIAdvancedNotificationParameterValue  NotificationID="123" AdvancedNotificationParameterID="11" ParameterValue="" ParameterDescription="Key_Sensor"/>
    </APIAdvancedNotificationParameterValueList>
  </Result>
</SensorRestAPI>

Method: NotificationListAdvancedAutomatedSchedule
Lists proccess frequency for an advanced notification

Parameters

NotificationID:

Long

Unique identifier of the Notification

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AdvancedNotificationAutomatedScheduleSet</Method>
  <Result xsi:type="xsd:collection">
      <APIAdvancedNotificationAutomatedSchedule NotificationID="123" AdvancedNotificationID="14" ProcessFrequency="1440" Description="Low  Temperature" LastProcessDate="10/10/2016 2:55:01 PM"/>
  </Result>
</SensorRestAPI>

Method: AdvancedNotificationAutomatedScheduleSet
Sets process frequency for advanced notifications

Parameters

NotificationID:	Long	Unique identifier of the Notification
processFrequency:	Integer	Time, in minutes, between processing. Example: every hour - 60 , every 6 hours - 360, once daily - 1440

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>AdvancedNotificationAutomatedScheduleSet</Method>
  <Result xsi:type="xsd:collection">
      <APIAdvancedNotificationAutomatedSchedule NotificationID="123" AdvancedNotificationID="14" ProcessFrequency="1440" Description=" Low Temperature" LastProcessDate="10/10/2016 2:55:01 PM"/>
  </Result>
</SensorRestAPI>

Method: WebHookGet
Returns settings used to send data to external source.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

&<SensorRestAPI>
  <Method>WebHookGet</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookGet ConnectionInfo="http://www.mydomain.com/{1}" BrokenCount="0" LastResult="ok" SendingEnabled="True" RetriesDisabled="True" SendWithoutDataMessage="True" AuthenticationEnabled="False"/>
  </Result>
</SensorRestAPI>

Method: WebHookCreate
Sets configuration to send data to external source. Returns Webhook configuration

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
baseUrl:	String	Url of 3rd party server and defined data to send (Url Encoded). If this value contains an & character, it must be replaced by its urlencoding, %26. Depending on the context, you may also have to escape a % using %25

Example

Example Output

&<SensorRestAPI>
  <Method>WebHookCreate</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookGet ConnectionInfo="http://www.mydomain.com/{1}" BrokenCount="0" LastResult="ok" SendingEnabled="True" RetriesDisabled="True"  SendWithoutDataMessage="True" AuthenticationEnabled="False"/>
  </Result>
</SensorRestAPI>

Method: WebHookRemove
Deletes exsiting webhook

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookRemove</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: WebHookSetAuthentication
Turns on authentication and sets username and password for desired webhook.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
Username:	String	Username for the webhook authentication.
Password:	String	Password for the webhook authentication.

Example

Example Output

&<SensorRestAPI>
  <Method>WebHookSetAuthentication</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookGet ConnectionInfo="http://www.mydomain.com/{1}" BrokenCount="0" LastResult="ok" SendingEnabled="True" RetriesDisabled="True" SendWithoutDataMessage="True" AuthenticationEnabled="True"/>
  </Result>
</SensorRestAPI>

Method: WebHookRemoveAuthentication
Turns off authentication for desired webhook.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

&<SensorRestAPI>
  <Method>WebHookRemoveAuthentication</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookGet ConnectionInfo="http://www.mydomain.com/{1}" BrokenCount="0" LastResult="ok" SendingEnabled="True" RetriesDisabled="True" SendWithoutDataMessage="True" AuthenticationEnabled="False"/>
  </Result>
</SensorRestAPI>

Method: WebHookAddCookie
Adds a cookie to the specified Webhook.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
Key:	String	Which is a unique identifier for some item of data.
Value:	String	Either the data that is identified or a pointer to the location of that data.

Example

Example Output

<SensorRestAPI>
  <Method>WebHookAddCookie</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookPropertyList>
      <APIWebHookProperty WebHookPropertyID="42" Type="cookie" StringValue="TestKey=TestValue" Key="TestKey" Value="TestValue"/>
      <APIWebHookProperty WebHookPropertyID="43" Type="cookie" StringValue="CookieKey=CookieValue" Key="TestKey" Value="TestValue"/>
    </APIWebHookPropertyList>
  </Result>
</SensorRestAPI>

Method: WebHookRemoveCookie
Deletes desired cookie from webhook

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
webHookPropertyID:	Integer	Unique identifier of Cookie.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookRemoveCookie</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: WebHookCookieList
Returns list of cookies attached to the specified Webhook.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<SensorRestAPI>
  <Method>WebHookCookieList</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookPropertyList>
      <APIWebHookProperty WebHookPropertyID="42" Type="cookie" StringValue="TestKey=TestValue" Key="TestKey" Value="TestValue"/>
      <APIWebHookProperty WebHookPropertyID="43" Type="cookie" StringValue="CookieKey=CookieValue" Key="TestKey" Value="TestValue"/>
    </APIWebHookPropertyList>
  </Result>
</SensorRestAPI>

Method: WebHookAddHeader
Adds a custom header to the specified Webhook.

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
Key:	String	Which is a unique identifier for some item of data.
Value:	String	Either the data that is identified or a pointer to the location of that data.

Example

Example Output

<SensorRestAPI>
  <Method>WebHookAddHeader</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookPropertyList>
      <APIWebHookProperty WebHookPropertyID="42" Type="header" StringValue="TestKey=TestValue" Key="TestKey" Value="TestValue"/>
      <APIWebHookProperty WebHookPropertyID="43" Type="header" StringValue="HeaderKey=HeaderValue" Key="TestKey" Value="TestValue"/>
    </APIWebHookPropertyList>
  </Result>
</SensorRestAPI>

Method: WebHookRemoveHeader
Deletes desired Header from webhook

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
webHookPropertyID:	Integer	Unique identifier of Header.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookRemoveHeader</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: WebHookHeaderList
Returns list of Headers attached to the specified Webhook.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<SensorRestAPI>
  <Method>WebHookHeaderList</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookPropertyList>
      <APIWebHookProperty WebHookPropertyID="42" Type="Header" StringValue="TestKey=TestValue" Key="TestKey" Value="TestValue"/>
      <APIWebHookProperty WebHookPropertyID="43" Type="Header" StringValue="HeaderKey=HeaderValue" Key="TestKey" Value="TestValue"/>
    </APIWebHookPropertyList>
  </Result>
</SensorRestAPI>

Method: WebHookResetBroken
Resets the send count of the Webhook to have it attempt to resend subscriptions again.

Parameters

accountID:

Integer (optional)

Unique identifier of SubAccount. If omitted, Your default account will be used.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookResetBroken</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: WebHookAttempts
Returns either all attempts information or only unsuccessful attempts information

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
showOnlyErrors	boolean	Return only unsuccessful attempts
fromDate:	DateTime	Start of range from which attempts will be returned
toDate:	DateTime	End of range from which attempts will be returned
lastAttemptID:	Integer (optional)	Only return attempts received after this attempt ID

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookAttempts</Method>
  <Result xsi:type="xsd:string">
    <APIWebHookAttemptsList>
      <APIWebHookAttempts AttemptID="569" CreateDate="4/4/2016 8:29:42 PM" Url="http://mydomain.com/{1}" ProcessDate="4/4/2016 8:29:42 PM" Retry="False" AttemptCount="1" Status="Success"/>>
      <APIWebHookAttempts AttemptID="568" CreateDate="4/4/2016 8:29:42 PM" Url="http://mydomain.com/{1}" ProcessDate="4/4/2016 8:28:00 PM" Retry="False" AttemptCount="1" Status="Success"/>>
    </APIWebHookAttemptsList>
  </Result>
</SensorRestAPI>

Method: WebHookResend
Requeue a webhook attempt to be retried. Limit of 10 retries per attempt.

Parameters

attemptID:

Integer

Unique identifier of Attempt to resend

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebHookResend</Method>
  <Result xsi:type="xsd:string">Success</Result>
</SensorRestAPI>

Method: WebHookAttemptBody
Returns Body of specified Attempt

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
attemptID:	Integer	Unique identifier of Attempt to resend

Example

Example Output

&<SensorRestAPI>
  <Method>APIWebHookAttemptBody</Method>
  <Result xsi:type="xsd:collection">
    <APIWebHookAttemptBody Body="{"gatewayMessage":{ "gatewayID":"xxxx" , "gatewayName":"USB+Service+-+xxxx" , "accountID":"x", "networkID":"xxxx" , "messageType":"0" , "power":"0", "batteryLevel": "101" , "date": "2016-04-04 20:29:47", "count":"1", "signalStrength": "0", "pendingChange": "False" }}"/>>
  </Result>
</SensorRestAPI>

Method: WebhookListNotificationSettings
Lists when and to whom emails are sent when your Data Push fails multiple times in a row

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
None:

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebhookListNotificationSettings</Method>
  <Result xsi:type="xsd:collection">
   <APINotificationSettings UserToBeNotified="John Doe" UsersBrokenCountLimit="10" LastEmailDate="10/20/2016 8:57:31 PM" LargestBrokenCount="Webhook 18"/>
  </Result>
</SensorRestAPI>

Method: WebhookNotificationSettingsSet
Allows you to set when and to whom emails are sent when your Data Push fails multiple times in a row

Parameters

accountID:	Integer (optional)	Unique identifier of SubAccount. If omitted, Your default account will be used.
UserIDToBeNotified:	long	Unique identifier of user that will recieve the broken count notification.
brokenCountThreshold:	Integer	The number of failed attempts before a notification is sent.

Example

Example Output

<?xml version="1.0" encoding="utf-8"?>
<SensorRestAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Method>WebhookNotificationSettingsSet</Method>
  <Result xsi:type="xsd:collection">
   <APINotificationSettings UserToBeNotified="John Doe" UsersBrokenCountLimit="10" LastEmailDate="10/20/2016 8:57:31 PM" LargestBrokenCount="Webhook 18"/>
  </Result>
</SensorRestAPI>

API Explorer

EndPoint

Choose an API from the dropdown

Response Format

JSON XML

Request URL

Headers (Authentication)

	KEY	VALUE

Parameters

	KEY	VALUE

API Result

Authorization

Parameters

Explore our APIs

Time Zones

Parameters

Example

Example Output

Time Zones with Region

Parameters

Example

Example Output

SMS Carriers

Parameters

Example

Example Output

Get Application ID

Parameters

Example

Example Output

Get Datum By Type

Parameters

Example

Example Output

Account Number Available

Parameters

Example

Example Outputs

User Name Available

Parameters

Example

Example Outputs

Notification Email Available

Parameters

Example

Example Outputs

Sensor Lookup

Parameters

Example

Example Output

Gateway Lookup

Parameters

Example

Example Output

Calibration Facility List

Parameters

Example

Example Output

Create Account

Parameters

Example

Example Outputs

Account Get

Parameters

Example

Example Outputs

Edit Account Information

Parameters

Example

Example Outputs

Edit Customer Information

Parameters

Example

Example Outputs

Get Customer Permissions

Parameters

Example

Example Output

Edit Customer Permissions

Parameters

Example

Example Outputs

Retrieve Username

Parameters

Example

Example Outputs

Create Account User

Parameters

Example

Example Outputs

Account User Delete