svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetAssociatedPartners

Returns the Partners associated with a Location object from the database

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

<?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>
    <GetAssociatedPartners xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
    </GetAssociatedPartners>
  </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>
    <GetAssociatedPartnersResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAssociatedPartnersResult>
        <PartnerList>
          <PartnerInfo>
            <PartnerID>int</PartnerID>
            <PartnerName>string</PartnerName>
            <PartnerDescription>string</PartnerDescription>
            <ClientID>string</ClientID>
            <ClientSecret>string</ClientSecret>
            <PartnerAPIKey>string</PartnerAPIKey>
            <AccessToken>string</AccessToken>
            <TokenValidity>boolean</TokenValidity>
            <MaxDeviceSupported>int</MaxDeviceSupported>
            <DeviceID>long</DeviceID>
            <IsExistingSkybellUser>int</IsExistingSkybellUser>
            <SetupStateID>short</SetupStateID>
            <CallbackURL>string</CallbackURL>
            <DevicePermission>string</DevicePermission>
            <AdditionalInfo>string</AdditionalInfo>
          </PartnerInfo>
          <PartnerInfo>
            <PartnerID>int</PartnerID>
            <PartnerName>string</PartnerName>
            <PartnerDescription>string</PartnerDescription>
            <ClientID>string</ClientID>
            <ClientSecret>string</ClientSecret>
            <PartnerAPIKey>string</PartnerAPIKey>
            <AccessToken>string</AccessToken>
            <TokenValidity>boolean</TokenValidity>
            <MaxDeviceSupported>int</MaxDeviceSupported>
            <DeviceID>long</DeviceID>
            <IsExistingSkybellUser>int</IsExistingSkybellUser>
            <SetupStateID>short</SetupStateID>
            <CallbackURL>string</CallbackURL>
            <DevicePermission>string</DevicePermission>
            <AdditionalInfo>string</AdditionalInfo>
          </PartnerInfo>
        </PartnerList>
      </GetAssociatedPartnersResult>
    </GetAssociatedPartnersResponse>
  </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>
    <GetAssociatedPartners xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
    </GetAssociatedPartners>
  </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>
    <GetAssociatedPartnersResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAssociatedPartnersResult>
        <PartnerList>
          <PartnerInfo>
            <PartnerID>int</PartnerID>
            <PartnerName>string</PartnerName>
            <PartnerDescription>string</PartnerDescription>
            <ClientID>string</ClientID>
            <ClientSecret>string</ClientSecret>
            <PartnerAPIKey>string</PartnerAPIKey>
            <AccessToken>string</AccessToken>
            <TokenValidity>boolean</TokenValidity>
            <MaxDeviceSupported>int</MaxDeviceSupported>
            <DeviceID>long</DeviceID>
            <IsExistingSkybellUser>int</IsExistingSkybellUser>
            <SetupStateID>short</SetupStateID>
            <CallbackURL>string</CallbackURL>
            <DevicePermission>string</DevicePermission>
            <AdditionalInfo>string</AdditionalInfo>
          </PartnerInfo>
          <PartnerInfo>
            <PartnerID>int</PartnerID>
            <PartnerName>string</PartnerName>
            <PartnerDescription>string</PartnerDescription>
            <ClientID>string</ClientID>
            <ClientSecret>string</ClientSecret>
            <PartnerAPIKey>string</PartnerAPIKey>
            <AccessToken>string</AccessToken>
            <TokenValidity>boolean</TokenValidity>
            <MaxDeviceSupported>int</MaxDeviceSupported>
            <DeviceID>long</DeviceID>
            <IsExistingSkybellUser>int</IsExistingSkybellUser>
            <SetupStateID>short</SetupStateID>
            <CallbackURL>string</CallbackURL>
            <DevicePermission>string</DevicePermission>
            <AdditionalInfo>string</AdditionalInfo>
          </PartnerInfo>
        </PartnerList>
      </GetAssociatedPartnersResult>
    </GetAssociatedPartnersResponse>
  </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/GetAssociatedPartners?SessionId=string&LocationId=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"?>
<PartnerListResult xmlns="https://services.alarmnet.com/TC2/">
  <PartnerList>
    <PartnerInfo>
      <PartnerID>int</PartnerID>
      <PartnerName>string</PartnerName>
      <PartnerDescription>string</PartnerDescription>
      <ClientID>string</ClientID>
      <ClientSecret>string</ClientSecret>
      <PartnerAPIKey>string</PartnerAPIKey>
      <AccessToken>string</AccessToken>
      <TokenValidity>boolean</TokenValidity>
      <MaxDeviceSupported>int</MaxDeviceSupported>
      <DeviceID>long</DeviceID>
      <IsExistingSkybellUser>int</IsExistingSkybellUser>
      <SetupStateID>short</SetupStateID>
      <CallbackURL>string</CallbackURL>
      <DevicePermission>string</DevicePermission>
      <AdditionalInfo>string</AdditionalInfo>
    </PartnerInfo>
    <PartnerInfo>
      <PartnerID>int</PartnerID>
      <PartnerName>string</PartnerName>
      <PartnerDescription>string</PartnerDescription>
      <ClientID>string</ClientID>
      <ClientSecret>string</ClientSecret>
      <PartnerAPIKey>string</PartnerAPIKey>
      <AccessToken>string</AccessToken>
      <TokenValidity>boolean</TokenValidity>
      <MaxDeviceSupported>int</MaxDeviceSupported>
      <DeviceID>long</DeviceID>
      <IsExistingSkybellUser>int</IsExistingSkybellUser>
      <SetupStateID>short</SetupStateID>
      <CallbackURL>string</CallbackURL>
      <DevicePermission>string</DevicePermission>
      <AdditionalInfo>string</AdditionalInfo>
    </PartnerInfo>
  </PartnerList>
</PartnerListResult>

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/GetAssociatedPartners HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionId=string&LocationId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<PartnerListResult xmlns="https://services.alarmnet.com/TC2/">
  <PartnerList>
    <PartnerInfo>
      <PartnerID>int</PartnerID>
      <PartnerName>string</PartnerName>
      <PartnerDescription>string</PartnerDescription>
      <ClientID>string</ClientID>
      <ClientSecret>string</ClientSecret>
      <PartnerAPIKey>string</PartnerAPIKey>
      <AccessToken>string</AccessToken>
      <TokenValidity>boolean</TokenValidity>
      <MaxDeviceSupported>int</MaxDeviceSupported>
      <DeviceID>long</DeviceID>
      <IsExistingSkybellUser>int</IsExistingSkybellUser>
      <SetupStateID>short</SetupStateID>
      <CallbackURL>string</CallbackURL>
      <DevicePermission>string</DevicePermission>
      <AdditionalInfo>string</AdditionalInfo>
    </PartnerInfo>
    <PartnerInfo>
      <PartnerID>int</PartnerID>
      <PartnerName>string</PartnerName>
      <PartnerDescription>string</PartnerDescription>
      <ClientID>string</ClientID>
      <ClientSecret>string</ClientSecret>
      <PartnerAPIKey>string</PartnerAPIKey>
      <AccessToken>string</AccessToken>
      <TokenValidity>boolean</TokenValidity>
      <MaxDeviceSupported>int</MaxDeviceSupported>
      <DeviceID>long</DeviceID>
      <IsExistingSkybellUser>int</IsExistingSkybellUser>
      <SetupStateID>short</SetupStateID>
      <CallbackURL>string</CallbackURL>
      <DevicePermission>string</DevicePermission>
      <AdditionalInfo>string</AdditionalInfo>
    </PartnerInfo>
  </PartnerList>
</PartnerListResult>

Parameter	Value
SessionId:
LocationId: