GET | /users/{Id} | gets a single bootview user by user id |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | query | Guid | Yes | the GUID user id |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
UserName | form | string | No | |
FirstName | form | string | No | |
LastName | form | string | No | |
Alias | form | string | No | |
EmailAddress | form | string | No | |
City | form | string | No | |
StateCode | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
GroupId | form | Guid | No | |
IsActive | form | bool | No | |
IsInternal | form | bool | No | |
LanguageCode | form | string | No | |
MobilePhone | form | string | No | |
Phone | form | string | No | |
TimeZone | form | string | No | |
Zip | form | string | No | |
Status | form | int | No | |
HomePageId | form | int? | No | |
GroupPermissions | form | List<string> | No | |
MobileAppsAllowed | form | bool | No | |
CanUseMIMS | form | bool | No | |
ApiTokenId | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/{Id} HTTP/1.1 Host: api.paylock.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: 00000000000000000000000000000000, userName: String, firstName: String, lastName: String, alias: String, emailAddress: String, city: String, stateCode: String, address1: String, address2: String, groupId: 00000000000000000000000000000000, isActive: False, isInternal: False, languageCode: String, mobilePhone: String, phone: String, timeZone: String, zip: String, status: 0, homePageId: 0, groupPermissions: [ String ], mobileAppsAllowed: False, canUseMIMS: False, apiTokenId: 00000000000000000000000000000000 }