svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

SaveUser

DEPRECATED in TC Multilingual - [TC2.1+] Replacement for SaveCreateUserInfo. Stores User information when editing self/another user or creating a new User

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

<?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>
    <SaveUser xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <UserDetails>
        <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>
          <LocationUserAuthorization>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationUserAuthorization>
          <LocationUserAuthorization>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationUserAuthorization>
        </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>
        <ImageChanged>boolean</ImageChanged>
        <Image>base64Binary</Image>
        <ImageId>long</ImageId>
        <PhotoURL>string</PhotoURL>
        <AdminAccess>int</AdminAccess>
        <UserTypeID>int</UserTypeID>
        <UserManagementOptions>
          <IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
          <IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
        </UserManagementOptions>
        <PromptForUserCode>boolean</PromptForUserCode>
        <OutOfSyncCount>int</OutOfSyncCount>
        <IsExternalUser>int</IsExternalUser>
      </UserDetails>
      <AdditionalInput>string</AdditionalInput>
    </SaveUser>
  </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>
    <SaveUserResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveUserResult>
        <UserId>long</UserId>
        <ResultPhotoURL>string</ResultPhotoURL>
      </SaveUserResult>
    </SaveUserResponse>
  </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>
    <SaveUser xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <UserDetails>
        <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>
          <LocationUserAuthorization>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationUserAuthorization>
          <LocationUserAuthorization>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceList xsi:nil="true" />
            <PhotoURL>string</PhotoURL>
          </LocationUserAuthorization>
        </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>
        <ImageChanged>boolean</ImageChanged>
        <Image>base64Binary</Image>
        <ImageId>long</ImageId>
        <PhotoURL>string</PhotoURL>
        <AdminAccess>int</AdminAccess>
        <UserTypeID>int</UserTypeID>
        <UserManagementOptions>
          <IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
          <IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
        </UserManagementOptions>
        <PromptForUserCode>boolean</PromptForUserCode>
        <OutOfSyncCount>int</OutOfSyncCount>
        <IsExternalUser>int</IsExternalUser>
      </UserDetails>
      <AdditionalInput>string</AdditionalInput>
    </SaveUser>
  </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>
    <SaveUserResponse xmlns="https://services.alarmnet.com/TC2/">
      <SaveUserResult>
        <UserId>long</UserId>
        <ResultPhotoURL>string</ResultPhotoURL>
      </SaveUserResult>
    </SaveUserResponse>
  </soap12:Body>
</soap12:Envelope>