svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

SaveLocationSimple

Saves the data associated with a LocationInfo object to the database. Since this method will only update an existing Location, you are required to pass in its LocationId. Pass in a null value for the Image byte array when either the image has not changed or when the default imageIs to be used. Any previous image will be deleted when either a null or actual image is saved. At the curent triggerTime, the Alias is for the one security system associated with this location.

Test

The test form is only available for requests from the local machine.

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/SaveLocationSimple"

<?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>
    <SaveLocationSimple xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <Locale>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </Locale>
      <Image>base64Binary</Image>
      <dataChanged>boolean</dataChanged>
      <imageChanged>boolean</imageChanged>
      <Alias>string</Alias>
    </SaveLocationSimple>
  </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>
    <SaveLocationSimpleResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveLocationSimpleResult>
        <LocationInfoSimple>
          <LocationId>long</LocationId>
          <LocationName>string</LocationName>
          <AccountId>long</AccountId>
          <PhotoId>long</PhotoId>
          <TimeZoneId>int</TimeZoneId>
          <PhotoURL>string</PhotoURL>
          <SetDefaultLocationName>boolean</SetDefaultLocationName>
          <SecuritySystemAlias>string</SecuritySystemAlias>
          <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
          <CountryID>long</CountryID>
          <StreetNumber>string</StreetNumber>
          <StreetName>string</StreetName>
          <City>string</City>
          <StateID>long</StateID>
          <PostalCode>string</PostalCode>
          <TemperatureUnits>string</TemperatureUnits>
          <Latitude>string</Latitude>
          <Longitude>string</Longitude>
        </LocationInfoSimple>
      </SaveLocationSimpleResult>
    </SaveLocationSimpleResponse>
  </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>
    <SaveLocationSimple xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <Locale>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </Locale>
      <Image>base64Binary</Image>
      <dataChanged>boolean</dataChanged>
      <imageChanged>boolean</imageChanged>
      <Alias>string</Alias>
    </SaveLocationSimple>
  </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>
    <SaveLocationSimpleResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveLocationSimpleResult>
        <LocationInfoSimple>
          <LocationId>long</LocationId>
          <LocationName>string</LocationName>
          <AccountId>long</AccountId>
          <PhotoId>long</PhotoId>
          <TimeZoneId>int</TimeZoneId>
          <PhotoURL>string</PhotoURL>
          <SetDefaultLocationName>boolean</SetDefaultLocationName>
          <SecuritySystemAlias>string</SecuritySystemAlias>
          <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
          <CountryID>long</CountryID>
          <StreetNumber>string</StreetNumber>
          <StreetName>string</StreetName>
          <City>string</City>
          <StateID>long</StateID>
          <PostalCode>string</PostalCode>
          <TemperatureUnits>string</TemperatureUnits>
          <Latitude>string</Latitude>
          <Longitude>string</Longitude>
        </LocationInfoSimple>
      </SaveLocationSimpleResult>
    </SaveLocationSimpleResponse>
  </soap12:Body>
</soap12:Envelope>