GET api/v1/eventSummary/locations/{locationId}/additionalInput/{additionalInput}
Get Summary of Configured Notification Events at the Given Location. Equivalent SOAP API: GetEventSummary
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Location ID |
integer |
Required |
additionalInput |
additionalInput |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
SummaryConfiguredEventString
SummaryConfiguredEventStringName | Description | Type | Additional information |
---|---|---|---|
EventSummary | string |
None. |
|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "EventSummary": "sample string 1", "ResultCode": 2, "ResultData": "sample string 3" }
application/xml, text/xml
Sample:
<SummaryConfiguredEventString xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData"> <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode> <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData> <EventSummary>sample string 1</EventSummary> </SummaryConfiguredEventString>