svcTC2API
Click here for a complete list of operations.
GetUserDetails
Deprecated in TC Multilingual - [TC2.1+] Replacement for GetUserInfo. Get User information when editing another user or editing yourself
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/GetUserDetails" <?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> <GetUserDetails xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <ManageUserId>long</ManageUserId> <UserTypeId>int</UserTypeId> <AdditionalInput>string</AdditionalInput> </GetUserDetails> </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> <GetUserDetailsResponse xmlns="https://services.alarmnet.com/TC2/"> <GetUserDetailsResult> <UserDetails> <UserId>long</UserId> <UserName>string</UserName> <PassWord>string</PassWord> <FirstName>string</FirstName> <LastName>string</LastName> <LocaleID>int</LocaleID> <Enabled>boolean</Enabled> <PhoneList> <PhoneInfo xsi:nil="true" /> <PhoneInfo xsi:nil="true" /> </PhoneList> <EmailList> <EmailInfo xsi:nil="true" /> <EmailInfo xsi:nil="true" /> </EmailList> <LocationList> <LocationUserAuthorization xsi:nil="true" /> <LocationUserAuthorization xsi:nil="true" /> </LocationList> <FeatureInfo> <UserFeatureCacheInfo xsi:nil="true" /> <UserFeatureCacheInfo xsi:nil="true" /> </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> <NotificationList> <NotificationGroups xsi:nil="true" /> <NotificationGroups xsi:nil="true" /> </NotificationList> </UserDetails> </GetUserDetailsResult> </GetUserDetailsResponse> </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> <GetUserDetails xmlns="https://services.alarmnet.com/TC2/"> <SessionID>string</SessionID> <ManageUserId>long</ManageUserId> <UserTypeId>int</UserTypeId> <AdditionalInput>string</AdditionalInput> </GetUserDetails> </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> <GetUserDetailsResponse xmlns="https://services.alarmnet.com/TC2/"> <GetUserDetailsResult> <UserDetails> <UserId>long</UserId> <UserName>string</UserName> <PassWord>string</PassWord> <FirstName>string</FirstName> <LastName>string</LastName> <LocaleID>int</LocaleID> <Enabled>boolean</Enabled> <PhoneList> <PhoneInfo xsi:nil="true" /> <PhoneInfo xsi:nil="true" /> </PhoneList> <EmailList> <EmailInfo xsi:nil="true" /> <EmailInfo xsi:nil="true" /> </EmailList> <LocationList> <LocationUserAuthorization xsi:nil="true" /> <LocationUserAuthorization xsi:nil="true" /> </LocationList> <FeatureInfo> <UserFeatureCacheInfo xsi:nil="true" /> <UserFeatureCacheInfo xsi:nil="true" /> </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> <NotificationList> <NotificationGroups xsi:nil="true" /> <NotificationGroups xsi:nil="true" /> </NotificationList> </UserDetails> </GetUserDetailsResult> </GetUserDetailsResponse> </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/GetUserDetails?SessionID=string&ManageUserId=string&UserTypeId=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"?> <UserDetailResults xmlns="https://services.alarmnet.com/TC2/"> <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> <SmsCarrier>int</SmsCarrier> </EmailInfo> <EmailInfo> <EmailAddress>string</EmailAddress> <IsEmailValidated>boolean</IsEmailValidated> <NotificationMethodID>int</NotificationMethodID> <CountryCallingCode>int</CountryCallingCode> <eventypeId>long</eventypeId> <CountryID>long</CountryID> <SmsCarrier>int</SmsCarrier> </EmailInfo> </EmailList> <LocationList> <LocationUserAuthorization> <LocationID>long</LocationID> <LocationName>string</LocationName> <DeviceList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <PhotoURL>string</PhotoURL> </LocationUserAuthorization> <LocationUserAuthorization> <LocationID>long</LocationID> <LocationName>string</LocationName> <DeviceList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <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> <NotificationList> <NotificationGroups> <NotificationListID>string</NotificationListID> </NotificationGroups> <NotificationGroups> <NotificationListID>string</NotificationListID> </NotificationGroups> </NotificationList> </UserDetails> </UserDetailResults>
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/GetUserDetails HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&ManageUserId=string&UserTypeId=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"?> <UserDetailResults xmlns="https://services.alarmnet.com/TC2/"> <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> <SmsCarrier>int</SmsCarrier> </EmailInfo> <EmailInfo> <EmailAddress>string</EmailAddress> <IsEmailValidated>boolean</IsEmailValidated> <NotificationMethodID>int</NotificationMethodID> <CountryCallingCode>int</CountryCallingCode> <eventypeId>long</eventypeId> <CountryID>long</CountryID> <SmsCarrier>int</SmsCarrier> </EmailInfo> </EmailList> <LocationList> <LocationUserAuthorization> <LocationID>long</LocationID> <LocationName>string</LocationName> <DeviceList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <PhotoURL>string</PhotoURL> </LocationUserAuthorization> <LocationUserAuthorization> <LocationID>long</LocationID> <LocationName>string</LocationName> <DeviceList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <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> <NotificationList> <NotificationGroups> <NotificationListID>string</NotificationListID> </NotificationGroups> <NotificationGroups> <NotificationListID>string</NotificationListID> </NotificationGroups> </NotificationList> </UserDetails> </UserDetailResults>