svcTC2API
Click here for a complete list of operations.
GetUsersEx
[TC2.1+] Replacement for GetUsers. Returns List of Real Users that one can manage if asked at AccountLevel. This also returns Real+Virtual Users if asked at Location Level.
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/GetUsersEx"
<?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>
<GetUsersEx xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LocationID>long</LocationID>
<AdditionalInput>string</AdditionalInput>
</GetUsersEx>
</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>
<GetUsersExResponse xmlns="https://services.alarmnet.com/TC2/">
<GetUsersExResult>
<UserManagementOptions>
<IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
<IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
</UserManagementOptions>
<Users>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo xsi:nil="true" />
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo xsi:nil="true" />
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
</Users>
<UrgentSyncCount>int</UrgentSyncCount>
</GetUsersExResult>
</GetUsersExResponse>
</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>
<GetUsersEx xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LocationID>long</LocationID>
<AdditionalInput>string</AdditionalInput>
</GetUsersEx>
</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>
<GetUsersExResponse xmlns="https://services.alarmnet.com/TC2/">
<GetUsersExResult>
<UserManagementOptions>
<IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
<IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
</UserManagementOptions>
<Users>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo xsi:nil="true" />
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo xsi:nil="true" />
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
</Users>
<UrgentSyncCount>int</UrgentSyncCount>
</GetUsersExResult>
</GetUsersExResponse>
</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/GetUsersEx?SessionID=string&LocationID=string&AdditionalInput=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"?>
<UserListResults xmlns="https://services.alarmnet.com/TC2/">
<UserManagementOptions>
<IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
<IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
</UserManagementOptions>
<Users>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo>
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeatureInfo>
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo>
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeatureInfo>
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
</Users>
<UrgentSyncCount>int</UrgentSyncCount>
</UserListResults>
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/GetUsersEx HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&LocationID=string&AdditionalInput=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<UserListResults xmlns="https://services.alarmnet.com/TC2/">
<UserManagementOptions>
<IsOptedForUserCodeManagement>boolean</IsOptedForUserCodeManagement>
<IsUserCodeDisplayed>boolean</IsUserCodeDisplayed>
</UserManagementOptions>
<Users>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo>
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeatureInfo>
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
<UserListDetail>
<UserId>long</UserId>
<UserName>string</UserName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Enabled>boolean</Enabled>
<IsValidated>boolean</IsValidated>
<FeatureInfo>
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<UserFeatureCacheInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeatureInfo>
<TimeStampUpdate>dateTime</TimeStampUpdate>
<ImageId>long</ImageId>
<PhotoURL>string</PhotoURL>
<UserTypeID>int</UserTypeID>
<OutOfSyncCount>int</OutOfSyncCount>
<IsDuplicateUserCode>boolean</IsDuplicateUserCode>
</UserListDetail>
</Users>
<UrgentSyncCount>int</UrgentSyncCount>
</UserListResults>