GET api/v1/users/{userId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
UserDetailsName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
ClubId | globally unique identifier |
Required |
|
FriendlyName | string |
Required String length: inclusive between 0 and 100 |
|
NotificationEmail | string |
Required String length: inclusive between 0 and 256 |
|
PersonId | globally unique identifier |
None. |
|
Remarks | string |
None. |
|
UserName | string |
Required String length: inclusive between 0 and 256 |
|
UserRoleIds | Collection of globally unique identifier |
None. |
|
AccountState | integer |
None. |
|
LastPasswordChangeOn | date |
None. |
|
ForcePasswordChangeNextLogon | boolean |
None. |
|
EmailConfirmed | boolean |
None. |
|
LanguageId | integer |
None. |
|
Id | globally unique identifier |
None. |
|
CanUpdateRecord | boolean |
None. |
|
CanDeleteRecord | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserId": "c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72", "ClubId": "0a262123-3c43-4d73-8e06-fc0d6f2032f9", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "109738f8-91be-46ed-80d0-45531ca320d7", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "be063823-0476-4cfe-9157-878a79beeb36", "6b80b9a2-e427-44fb-9fb9-8630603119cc" ], "AccountState": 7, "LastPasswordChangeOn": "2024-11-21T09:30:58.0064634+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72","ClubId":"0a262123-3c43-4d73-8e06-fc0d6f2032f9","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"109738f8-91be-46ed-80d0-45531ca320d7","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["be063823-0476-4cfe-9157-878a79beeb36","6b80b9a2-e427-44fb-9fb9-8630603119cc"],"AccountState":7,"LastPasswordChangeOn":"2024-11-21T09:30:58.0064634+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<UserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User"> <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord> <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord> <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72</Id> <AccountState>7</AccountState> <ClubId>0a262123-3c43-4d73-8e06-fc0d6f2032f9</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-11-21T09:30:58.0064634+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>109738f8-91be-46ed-80d0-45531ca320d7</PersonId> <Remarks>sample string 5</Remarks> <UserId>c7c88ae2-f18b-4cad-b3cd-2bb5fac33a72</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>be063823-0476-4cfe-9157-878a79beeb36</d2p1:guid> <d2p1:guid>6b80b9a2-e427-44fb-9fb9-8630603119cc</d2p1:guid> </UserRoleIds> </UserDetails>