svcTC2API
Click here for a complete list of operations.
GetWiFiLocations
Return a list of WiFi locations and devices.
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/GetWiFiLocations"
<?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>
<GetWiFiLocations xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LyricUsername>string</LyricUsername>
<LyricPassword>string</LyricPassword>
</GetWiFiLocations>
</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>
<GetWiFiLocationsResponse xmlns="https://services.alarmnet.com/TC2/">
<GetWiFiLocationsResult>
<WiFiLocations>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices xsi:nil="true" />
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices xsi:nil="true" />
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
</WiFiLocations>
</GetWiFiLocationsResult>
</GetWiFiLocationsResponse>
</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>
<GetWiFiLocations xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LyricUsername>string</LyricUsername>
<LyricPassword>string</LyricPassword>
</GetWiFiLocations>
</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>
<GetWiFiLocationsResponse xmlns="https://services.alarmnet.com/TC2/">
<GetWiFiLocationsResult>
<WiFiLocations>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices xsi:nil="true" />
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices xsi:nil="true" />
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
</WiFiLocations>
</GetWiFiLocationsResult>
</GetWiFiLocationsResponse>
</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/GetWiFiLocations?SessionID=string&LyricUsername=string&LyricPassword=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"?>
<WiFiLocationsResults xmlns="https://services.alarmnet.com/TC2/">
<WiFiLocations>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices>
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Devices>
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices>
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Devices>
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
</WiFiLocations>
</WiFiLocationsResults>
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/GetWiFiLocations HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&LyricUsername=string&LyricPassword=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<WiFiLocationsResults xmlns="https://services.alarmnet.com/TC2/">
<WiFiLocations>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices>
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Devices>
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
<WiFiLocationInfo>
<LyricLocationID>int</LyricLocationID>
<Name>string</Name>
<StreetAddress>string</StreetAddress>
<City>string</City>
<State>string</State>
<Country>string</Country>
<ZipCode>string</ZipCode>
<Devices>
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<WiFiDeviceResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Devices>
<TimeZone>string</TimeZone>
<DayLightSavingTimeEnabled>boolean</DayLightSavingTimeEnabled>
</WiFiLocationInfo>
</WiFiLocations>
</WiFiLocationsResults>