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": "5ebd103c-fff9-49f0-926f-4723b6d22e37", "ClubId": "ea9f6fc1-58f6-4807-aa31-1083cee95252", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "f9c890ac-9c9e-4ca6-971e-98e1d7c0f316", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "0fd7ab4f-ccdb-403b-ad68-713e31b9cb32", "ad638593-2588-4652-b3fd-71c21983df9c" ], "AccountState": 7, "LastPasswordChangeOn": "2024-10-29T15:42:44.1363336+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "5ebd103c-fff9-49f0-926f-4723b6d22e37", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"5ebd103c-fff9-49f0-926f-4723b6d22e37","ClubId":"ea9f6fc1-58f6-4807-aa31-1083cee95252","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"f9c890ac-9c9e-4ca6-971e-98e1d7c0f316","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["0fd7ab4f-ccdb-403b-ad68-713e31b9cb32","ad638593-2588-4652-b3fd-71c21983df9c"],"AccountState":7,"LastPasswordChangeOn":"2024-10-29T15:42:44.1363336+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"5ebd103c-fff9-49f0-926f-4723b6d22e37","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">5ebd103c-fff9-49f0-926f-4723b6d22e37</Id> <AccountState>7</AccountState> <ClubId>ea9f6fc1-58f6-4807-aa31-1083cee95252</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-10-29T15:42:44.1363336+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>f9c890ac-9c9e-4ca6-971e-98e1d7c0f316</PersonId> <Remarks>sample string 5</Remarks> <UserId>5ebd103c-fff9-49f0-926f-4723b6d22e37</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>0fd7ab4f-ccdb-403b-ad68-713e31b9cb32</d2p1:guid> <d2p1:guid>ad638593-2588-4652-b3fd-71c21983df9c</d2p1:guid> </UserRoleIds> </UserDetails>