IncidentTrigger APIs
-
Create Trigger
Description: Creates a new incident triggerUsage:
POST api/Incidents/Triggers/Create
Parameter Type Source Description Trig IncidentTrigger FromBody IncidentTrigger object Returns:
TriggerCode that uniquely identifies the new trigger
Examples:
//-- Currently no examples for XML --//
-
Update Trigger
Description: updates an existing incident triggerUsage:
PUT api/Incidents/Triggers/Update
Parameter Type Source Description Trig IncidentTrigger FromBody IncidentTrigger object Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
Delete Trigger
Description: deletes an existing incident triggerUsage:
DELETE api/Incidents/Triggers/Delete/{PropertyGuid}/{TriggerCode}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property for the trigger to delete TriggerCode Int32 FromUri The unique numerical code of the trigger to delete Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
List Incident Triggers
Description: Returns a list of Incident TriggersUsage:
GET api/Incidents/Triggers/{PropertyGuid}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return triggers for Returns:
List of Incident Triggers
Examples:
//-- Currently no examples for XML --//
-
Get Trigger
Description: returns an incident triggerUsage:
GET api/Incidents/Triggers/{PropertyGuid}/{TriggerCode}
Parameter Type Source Description PropertyGuid String FromUri The unique identifier of the property to return trigger for TriggerCode Int32 FromUri The unique numerical code identifying the trigger to return Returns:
Examples:
//-- Currently no examples for XML --//
-
Create Incident from Hardware
Description: Invokes a trigger from the press of a hardware based panic buttonUsage:
POST api/Incidents/Hardware/Create/{PropertyGuid}/{TriggerCode}/{HardwareId}
Parameter Type Source Description PropertyGuid String FromUri Unique identifier of the property to create an incident for TriggerCode Int32 FromUri Unique numerical identifier of the trigger to invoke HardwareId String FromUri Unique ID string of the hardware panic button that was pressed EntityPhoto String FromBody Optional base64 encoded photo of the person who pressed the panic button Returns:
returns 1 if incident created. returns 0 if incident already exists. returns -1 if error.
Examples:
//-- Currently no examples for XML --//
-
Check for Active Incident
Description: Checks if an incident is already active for the property and its corresponding message phone number.Usage:
GET api/Incidents/IsActive/{PropertyGuid}/{TriggerCode}
Parameter Type Source Description PropertyGuid String FromUri Unique identifier of the property TriggerCode Int32 FromUri Unique numerical identifier of the trigger Returns:
returns true if an active incident exists. returns false otherwise.
Examples:
//-- Currently no examples for XML --//
-
Create New Incident
Description: Creates a new Incident. This can be called to invoke a new incident directly without the need for triggers.Usage:
POST api/Incidents/Create
Parameter Type Source Description IncidentProfile NewIncident FromBody NewIncident object containing the required information for invoking a new incident Returns:
Guid that uniquely identifies the incident
Examples:
//-- Currently no examples for XML --//
-
Import Incident Contacts
Description: Imports contacts into an existing incidentUsage:
POST api/Incidents/Contacts/Import/{IncidentGuid}
Parameter Type Source Description IncidentGuid String FromUri Guid that uniquely identifies the incident to upload contacts into ResidentEntities IncidentContact[] FromBody array of IncidentContacts Returns:
0 on success
Examples:
//-- Currently no examples for XML --//
-
List Properties
Description: Returns a list of properties (campuses) available for incident managementUsage:
GET api/Incidents/Properties
Returns:
list of IncidentProperty objects
Examples:
//-- Currently no examples for XML --//