GET user/details
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
EditEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
Required |
|
| Username | string |
Required |
|
| Title | string |
Required |
|
| FirstNames | string |
Required |
|
| Surname | string |
Required |
|
| UserType | integer |
Required |
|
| Cell | string |
Required |
|
| string |
Required |
||
| TenantId | integer |
Required |
|
| EmployeeNo | string |
None. |
|
| UserPic | string |
None. |
|
| UserPicUrl | string |
None. |
|
| Roles | Collection of integer |
None. |
|
| ReportRoles | Collection of integer |
None. |
|
| Active | boolean |
None. |
|
| IDNumber | string |
None. |
|
| AuthenticationMethod | integer |
None. |
|
| OTP | string |
None. |
|
| MobileDeviceId | integer |
None. |
|
| AppointmentBookingMethod | integer |
None. |
|
| ManagerUserID | integer |
None. |
|
| Divisions | Collection of integer |
None. |
|
| VoipEnabled | boolean |
None. |
|
| VoipUsername | string |
None. |
|
| VoipPassword | string |
None. |
|
| VoipExtension | string |
None. |
|
| SuiteUsername | string |
None. |
|
| SuiteUserNo | string |
None. |
|
| isLsnUser | boolean |
None. |
|
| IsLsnMob | boolean |
None. |
|
| SendEnrollmentEmail | boolean |
None. |
|
| UseOwnPassword | boolean |
None. |
|
| Password | string |
None. |
|
| UserCode | string |
None. |
|
| TestingPassword | string |
None. |
|
| CanTestAlarm | boolean |
None. |
|
| ActiveTestor | boolean |
None. |
|
| TimeoutLimit | integer |
None. |
|
| BlockEmailSending | boolean |
None. |
|
| TrustedUser | boolean |
None. |
|
| IsTemplateUser | boolean |
None. |
|
| TemplateParentId | integer |
None. |
|
| EditMessage | string |
None. |
|
| Successful | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserID": 1,
"Username": "sample string 2",
"Title": "sample string 3",
"FirstNames": "sample string 4",
"Surname": "sample string 5",
"UserType": 6,
"Cell": "sample string 7",
"Email": "sample string 8",
"TenantId": 9,
"EmployeeNo": "sample string 10",
"UserPic": "sample string 11",
"UserPicUrl": "sample string 12",
"Roles": [
1,
2
],
"ReportRoles": [
1,
2
],
"Active": true,
"IDNumber": "sample string 14",
"AuthenticationMethod": 15,
"OTP": "sample string 16",
"MobileDeviceId": 1,
"AppointmentBookingMethod": 17,
"ManagerUserID": 1,
"Divisions": [
1,
2
],
"VoipEnabled": true,
"VoipUsername": "sample string 18",
"VoipPassword": "sample string 19",
"VoipExtension": "sample string 20",
"SuiteUsername": "sample string 21",
"SuiteUserNo": "sample string 22",
"isLsnUser": true,
"IsLsnMob": true,
"SendEnrollmentEmail": true,
"UseOwnPassword": true,
"Password": "sample string 26",
"UserCode": "sample string 27",
"TestingPassword": "sample string 28",
"CanTestAlarm": true,
"ActiveTestor": true,
"TimeoutLimit": 1,
"BlockEmailSending": true,
"TrustedUser": true,
"IsTemplateUser": true,
"TemplateParentId": 1,
"EditMessage": "sample string 33",
"Successful": true
}
text/html
Sample:
{"UserID":1,"Username":"sample string 2","Title":"sample string 3","FirstNames":"sample string 4","Surname":"sample string 5","UserType":6,"Cell":"sample string 7","Email":"sample string 8","TenantId":9,"EmployeeNo":"sample string 10","UserPic":"sample string 11","UserPicUrl":"sample string 12","Roles":[1,2],"ReportRoles":[1,2],"Active":true,"IDNumber":"sample string 14","AuthenticationMethod":15,"OTP":"sample string 16","MobileDeviceId":1,"AppointmentBookingMethod":17,"ManagerUserID":1,"Divisions":[1,2],"VoipEnabled":true,"VoipUsername":"sample string 18","VoipPassword":"sample string 19","VoipExtension":"sample string 20","SuiteUsername":"sample string 21","SuiteUserNo":"sample string 22","isLsnUser":true,"IsLsnMob":true,"SendEnrollmentEmail":true,"UseOwnPassword":true,"Password":"sample string 26","UserCode":"sample string 27","TestingPassword":"sample string 28","CanTestAlarm":true,"ActiveTestor":true,"TimeoutLimit":1,"BlockEmailSending":true,"TrustedUser":true,"IsTemplateUser":true,"TemplateParentId":1,"EditMessage":"sample string 33","Successful":true}
application/xml, text/xml
Sample:
<EditEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.UserManagement">
<EditMessage>sample string 33</EditMessage>
<Successful>true</Successful>
<Active>true</Active>
<ActiveTestor>true</ActiveTestor>
<AppointmentBookingMethod>17</AppointmentBookingMethod>
<AuthenticationMethod>15</AuthenticationMethod>
<BlockEmailSending>true</BlockEmailSending>
<CanTestAlarm>true</CanTestAlarm>
<Cell>sample string 7</Cell>
<Divisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</Divisions>
<Email>sample string 8</Email>
<EmployeeNo>sample string 10</EmployeeNo>
<FirstNames>sample string 4</FirstNames>
<IDNumber>sample string 14</IDNumber>
<IsLsnMob>true</IsLsnMob>
<IsTemplateUser>true</IsTemplateUser>
<ManagerUserID>1</ManagerUserID>
<MobileDeviceId>1</MobileDeviceId>
<OTP>sample string 16</OTP>
<Password>sample string 26</Password>
<ReportRoles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ReportRoles>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</Roles>
<SendEnrollmentEmail>true</SendEnrollmentEmail>
<SuiteUserNo>sample string 22</SuiteUserNo>
<SuiteUsername>sample string 21</SuiteUsername>
<Surname>sample string 5</Surname>
<TemplateParentId>1</TemplateParentId>
<TenantId>9</TenantId>
<TestingPassword>sample string 28</TestingPassword>
<TimeoutLimit>1</TimeoutLimit>
<Title>sample string 3</Title>
<TrustedUser>true</TrustedUser>
<UseOwnPassword>true</UseOwnPassword>
<UserCode>sample string 27</UserCode>
<UserID>1</UserID>
<UserPic>sample string 11</UserPic>
<UserPicUrl>sample string 12</UserPicUrl>
<UserType>6</UserType>
<Username>sample string 2</Username>
<VoipEnabled>true</VoipEnabled>
<VoipExtension>sample string 20</VoipExtension>
<VoipPassword>sample string 19</VoipPassword>
<VoipUsername>sample string 18</VoipUsername>
<isLsnUser>true</isLsnUser>
</EditEntity>