svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

SaveCreateUserInfo

[Depreciated in TC2.3+] Add a user to an existing account, save user updates to another user, save user updates to yourself

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

<?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>
    <SaveCreateUserInfo xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <UserInfo>
        <UserId>long</UserId>
        <UserName>string</UserName>
        <PassWord>string</PassWord>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <LocaleID>int</LocaleID>
        <Enabled>boolean</Enabled>
        <PhoneList>
          <PhoneInfo>
            <PhoneNumber>string</PhoneNumber>
            <IsPhoneValidated>boolean</IsPhoneValidated>
            <IsSMSControlEnabled>boolean</IsSMSControlEnabled>
          </PhoneInfo>
          <PhoneInfo>
            <PhoneNumber>string</PhoneNumber>
            <IsPhoneValidated>boolean</IsPhoneValidated>
            <IsSMSControlEnabled>boolean</IsSMSControlEnabled>
          </PhoneInfo>
        </PhoneList>
        <EmailList>
          <EmailInfo>
            <EmailAddress>string</EmailAddress>
            <IsEmailValidated>boolean</IsEmailValidated>
            <NotificationMethodID>int</NotificationMethodID>
            <CountryCallingCode>int</CountryCallingCode>
            <eventypeId>long</eventypeId>
            <CountryID>long</CountryID>
          </EmailInfo>
          <EmailInfo>
            <EmailAddress>string</EmailAddress>
            <IsEmailValidated>boolean</IsEmailValidated>
            <NotificationMethodID>int</NotificationMethodID>
            <CountryCallingCode>int</CountryCallingCode>
            <eventypeId>long</eventypeId>
            <CountryID>long</CountryID>
          </EmailInfo>
        </EmailList>
        <LocationList>
          <LocationInfoBasic_UserEnabled>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationInfoBasic_UserEnabled>
          <LocationInfoBasic_UserEnabled>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationInfoBasic_UserEnabled>
        </LocationList>
        <FeatureInfo>
          <UserFeatureCacheInfo>
            <FeatureId>int</FeatureId>
            <FeatureName>string</FeatureName>
            <FeatureEnabled>boolean</FeatureEnabled>
          </UserFeatureCacheInfo>
          <UserFeatureCacheInfo>
            <FeatureId>int</FeatureId>
            <FeatureName>string</FeatureName>
            <FeatureEnabled>boolean</FeatureEnabled>
          </UserFeatureCacheInfo>
        </FeatureInfo>
        <ResultCode>int</ResultCode>
        <ImageChanged>boolean</ImageChanged>
        <Image>base64Binary</Image>
        <ImageId>long</ImageId>
        <PhotoURL>string</PhotoURL>
        <AdminAccess>int</AdminAccess>
      </UserInfo>
    </SaveCreateUserInfo>
  </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>
    <SaveCreateUserInfoResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveCreateUserInfoResult>
        <UserId>long</UserId>
        <ResultPhotoURL>string</ResultPhotoURL>
      </SaveCreateUserInfoResult>
    </SaveCreateUserInfoResponse>
  </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>
    <SaveCreateUserInfo xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <UserInfo>
        <UserId>long</UserId>
        <UserName>string</UserName>
        <PassWord>string</PassWord>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <LocaleID>int</LocaleID>
        <Enabled>boolean</Enabled>
        <PhoneList>
          <PhoneInfo>
            <PhoneNumber>string</PhoneNumber>
            <IsPhoneValidated>boolean</IsPhoneValidated>
            <IsSMSControlEnabled>boolean</IsSMSControlEnabled>
          </PhoneInfo>
          <PhoneInfo>
            <PhoneNumber>string</PhoneNumber>
            <IsPhoneValidated>boolean</IsPhoneValidated>
            <IsSMSControlEnabled>boolean</IsSMSControlEnabled>
          </PhoneInfo>
        </PhoneList>
        <EmailList>
          <EmailInfo>
            <EmailAddress>string</EmailAddress>
            <IsEmailValidated>boolean</IsEmailValidated>
            <NotificationMethodID>int</NotificationMethodID>
            <CountryCallingCode>int</CountryCallingCode>
            <eventypeId>long</eventypeId>
            <CountryID>long</CountryID>
          </EmailInfo>
          <EmailInfo>
            <EmailAddress>string</EmailAddress>
            <IsEmailValidated>boolean</IsEmailValidated>
            <NotificationMethodID>int</NotificationMethodID>
            <CountryCallingCode>int</CountryCallingCode>
            <eventypeId>long</eventypeId>
            <CountryID>long</CountryID>
          </EmailInfo>
        </EmailList>
        <LocationList>
          <LocationInfoBasic_UserEnabled>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationInfoBasic_UserEnabled>
          <LocationInfoBasic_UserEnabled>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationInfoBasic_UserEnabled>
        </LocationList>
        <FeatureInfo>
          <UserFeatureCacheInfo>
            <FeatureId>int</FeatureId>
            <FeatureName>string</FeatureName>
            <FeatureEnabled>boolean</FeatureEnabled>
          </UserFeatureCacheInfo>
          <UserFeatureCacheInfo>
            <FeatureId>int</FeatureId>
            <FeatureName>string</FeatureName>
            <FeatureEnabled>boolean</FeatureEnabled>
          </UserFeatureCacheInfo>
        </FeatureInfo>
        <ResultCode>int</ResultCode>
        <ImageChanged>boolean</ImageChanged>
        <Image>base64Binary</Image>
        <ImageId>long</ImageId>
        <PhotoURL>string</PhotoURL>
        <AdminAccess>int</AdminAccess>
      </UserInfo>
    </SaveCreateUserInfo>
  </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>
    <SaveCreateUserInfoResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveCreateUserInfoResult>
        <UserId>long</UserId>
        <ResultPhotoURL>string</ResultPhotoURL>
      </SaveCreateUserInfoResult>
    </SaveCreateUserInfoResponse>
  </soap12:Body>
</soap12:Envelope>