svcTC2API
Click here for a complete list of operations.
GetEventMetaDataExV1
Get the Event Metadata applicable for the Given Location. Used for Notification Configuration
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx HTTP/1.1 Host: rs.alarmnet.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://services.alarmnet.com/TC2/GetEventMetaDataExV1" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetEventMetaDataExV1 xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <LocationID>long</LocationID> <AdditionalInput>string</AdditionalInput> </GetEventMetaDataExV1> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetEventMetaDataExV1Response xmlns="https://services.alarmnet.com/TC2/"> <GetEventMetaDataExV1Result> <EventClassCollection> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList xsi:nil="true" /> <EventTypeCollection xsi:nil="true" /> </EventClass> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList xsi:nil="true" /> <EventTypeCollection xsi:nil="true" /> </EventClass> </EventClassCollection> <LocationLimitations>string</LocationLimitations> <LocationCameraList> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> </LocationCameraList> <SceneDeviceInfoList> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> </SceneDeviceInfoList> </GetEventMetaDataExV1Result> </GetEventMetaDataExV1Response> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetEventMetaDataExV1 xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <LocationID>long</LocationID> <AdditionalInput>string</AdditionalInput> </GetEventMetaDataExV1> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetEventMetaDataExV1Response xmlns="https://services.alarmnet.com/TC2/"> <GetEventMetaDataExV1Result> <EventClassCollection> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList xsi:nil="true" /> <EventTypeCollection xsi:nil="true" /> </EventClass> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList xsi:nil="true" /> <EventTypeCollection xsi:nil="true" /> </EventClass> </EventClassCollection> <LocationLimitations>string</LocationLimitations> <LocationCameraList> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> </LocationCameraList> <SceneDeviceInfoList> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> </SceneDeviceInfoList> </GetEventMetaDataExV1Result> </GetEventMetaDataExV1Response> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /tc21api/tc2.asmx/GetEventMetaDataExV1?SessionID=string&LocationID=string&AdditionalInput=string HTTP/1.1 Host: rs.alarmnet.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <EventMetaDataExResult xmlns="https://services.alarmnet.com/TC2/"> <EventClassCollection> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventGroupList> <EventTypeCollection> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventTypeCollection> </EventClass> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventGroupList> <EventTypeCollection> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventTypeCollection> </EventClass> </EventClassCollection> <LocationLimitations>string</LocationLimitations> <LocationCameraList> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> </LocationCameraList> <SceneDeviceInfoList> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> </SceneDeviceInfoList> </EventMetaDataExResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx/GetEventMetaDataExV1 HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&LocationID=string&AdditionalInput=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <EventMetaDataExResult xmlns="https://services.alarmnet.com/TC2/"> <EventClassCollection> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventGroupList> <EventTypeCollection> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventTypeCollection> </EventClass> <EventClass EventClassID="long" EventClassDescription="string"> <EventGroupList> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventGroupList> <EventTypeCollection> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EventType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </EventTypeCollection> </EventClass> </EventClassCollection> <LocationLimitations>string</LocationLimitations> <LocationCameraList> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> <CameraSimple> <CameraDeviceID>long</CameraDeviceID> <CameraName>string</CameraName> </CameraSimple> </LocationCameraList> <SceneDeviceInfoList> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> <SceneDeviceInfo> <DeviceID>long</DeviceID> <DeviceName>string</DeviceName> <DeviceTypeID>int</DeviceTypeID> <PartnerID>int</PartnerID> </SceneDeviceInfo> </SceneDeviceInfoList> </EventMetaDataExResult>