svcTC2API
Click here for a complete list of operations.
GetInterfaceSchemaDetails
[DEPRECIATED] Request InterfaceSchema details for the given sessionID/username
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/GetInterfaceSchemaDetails" <?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> <GetInterfaceSchemaDetails xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> </GetInterfaceSchemaDetails> </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> <GetInterfaceSchemaDetailsResponse xmlns="https://services.alarmnet.com/TC2/"> <GetInterfaceSchemaDetailsResult> <InterfaceSchemaDetails> <InterfaceSchemaID>int</InterfaceSchemaID> <SchemaName>string</SchemaName> <BaseURL>string</BaseURL> <ProductName>string</ProductName> <CompanyName>string</CompanyName> <CompanyPhoneNumber>string</CompanyPhoneNumber> <WebsiteURL>string</WebsiteURL> <WarrantyPortalURL>string</WarrantyPortalURL> <LogoURL>string</LogoURL> <HelpURL>string</HelpURL> <CustomHeaderMessage>string</CustomHeaderMessage> <CustomFooterMessage>string</CustomFooterMessage> <MiscellaneousAttributes>string</MiscellaneousAttributes> <MailSenderName>string</MailSenderName> <SkinningEnabled>boolean</SkinningEnabled> </InterfaceSchemaDetails> </GetInterfaceSchemaDetailsResult> </GetInterfaceSchemaDetailsResponse> </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> <GetInterfaceSchemaDetails xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> </GetInterfaceSchemaDetails> </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> <GetInterfaceSchemaDetailsResponse xmlns="https://services.alarmnet.com/TC2/"> <GetInterfaceSchemaDetailsResult> <InterfaceSchemaDetails> <InterfaceSchemaID>int</InterfaceSchemaID> <SchemaName>string</SchemaName> <BaseURL>string</BaseURL> <ProductName>string</ProductName> <CompanyName>string</CompanyName> <CompanyPhoneNumber>string</CompanyPhoneNumber> <WebsiteURL>string</WebsiteURL> <WarrantyPortalURL>string</WarrantyPortalURL> <LogoURL>string</LogoURL> <HelpURL>string</HelpURL> <CustomHeaderMessage>string</CustomHeaderMessage> <CustomFooterMessage>string</CustomFooterMessage> <MiscellaneousAttributes>string</MiscellaneousAttributes> <MailSenderName>string</MailSenderName> <SkinningEnabled>boolean</SkinningEnabled> </InterfaceSchemaDetails> </GetInterfaceSchemaDetailsResult> </GetInterfaceSchemaDetailsResponse> </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/GetInterfaceSchemaDetails?SessionID=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"?> <InterfaceSchemaResults xmlns="https://services.alarmnet.com/TC2/"> <InterfaceSchemaDetails> <InterfaceSchemaID>int</InterfaceSchemaID> <SchemaName>string</SchemaName> <BaseURL>string</BaseURL> <ProductName>string</ProductName> <CompanyName>string</CompanyName> <CompanyPhoneNumber>string</CompanyPhoneNumber> <WebsiteURL>string</WebsiteURL> <WarrantyPortalURL>string</WarrantyPortalURL> <LogoURL>string</LogoURL> <HelpURL>string</HelpURL> <CustomHeaderMessage>string</CustomHeaderMessage> <CustomFooterMessage>string</CustomFooterMessage> <MiscellaneousAttributes>string</MiscellaneousAttributes> <MailSenderName>string</MailSenderName> <SkinningEnabled>boolean</SkinningEnabled> </InterfaceSchemaDetails> </InterfaceSchemaResults>
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/GetInterfaceSchemaDetails HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <InterfaceSchemaResults xmlns="https://services.alarmnet.com/TC2/"> <InterfaceSchemaDetails> <InterfaceSchemaID>int</InterfaceSchemaID> <SchemaName>string</SchemaName> <BaseURL>string</BaseURL> <ProductName>string</ProductName> <CompanyName>string</CompanyName> <CompanyPhoneNumber>string</CompanyPhoneNumber> <WebsiteURL>string</WebsiteURL> <WarrantyPortalURL>string</WarrantyPortalURL> <LogoURL>string</LogoURL> <HelpURL>string</HelpURL> <CustomHeaderMessage>string</CustomHeaderMessage> <CustomFooterMessage>string</CustomFooterMessage> <MiscellaneousAttributes>string</MiscellaneousAttributes> <MailSenderName>string</MailSenderName> <SkinningEnabled>boolean</SkinningEnabled> </InterfaceSchemaDetails> </InterfaceSchemaResults>