POST alert/setAlert?tokenUser={tokenUser}&tokenProject={tokenProject}&locationID={locationID}

Create alert data for the given location, project and user token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tokenUser

tokenUser retrieved by user/getUserToken method

string

Required

tokenProject

tokenProject retrieved by user/getUserProjects method

string

Required

locationID

Location (space\zone) id as retrieved by ifc/getIFCHierarchy and ifc/getIFCZones methods

string

Required

Body Parameters

alertType : Type of alert being created ,alertTopic : Alert topic ,alertSubject : Alert subject ,alertDescription : Alert description ,alertTime : Alert date in yyyy-mm-dd hh-mm format ,alertOwner : Alert owner ,importance : Alert importance

Dictionary of string [key] and string [value]

Request Formats

application/json, text/json

Sample:
{
  "sample string 1": "sample string 2",
  "sample string 3": "sample string 4"
}

text/plain

Sample:
{"sample string 1":"sample string 2","sample string 3":"sample string 4"}

application/xml, text/xml

Sample:
<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringstring>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </KeyValueOfstringstring>
</ArrayOfKeyValueOfstringstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/plain

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />