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": "358fe4aa-88c9-41e6-9f76-039c421d1088", "ClubId": "5287f210-d3d2-486c-a685-614a614a1588", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "6612e217-f277-4eae-ad25-a0d179e6fa8b", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "e446ee93-71fb-4bf4-b3b5-1eba31e78c35", "2851842f-20f4-448c-8343-d45f37bc6a2e" ], "AccountState": 7, "LastPasswordChangeOn": "2025-03-15T11:05:51.550368+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "358fe4aa-88c9-41e6-9f76-039c421d1088", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"358fe4aa-88c9-41e6-9f76-039c421d1088","ClubId":"5287f210-d3d2-486c-a685-614a614a1588","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6612e217-f277-4eae-ad25-a0d179e6fa8b","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["e446ee93-71fb-4bf4-b3b5-1eba31e78c35","2851842f-20f4-448c-8343-d45f37bc6a2e"],"AccountState":7,"LastPasswordChangeOn":"2025-03-15T11:05:51.550368+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"358fe4aa-88c9-41e6-9f76-039c421d1088","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">358fe4aa-88c9-41e6-9f76-039c421d1088</Id> <AccountState>7</AccountState> <ClubId>5287f210-d3d2-486c-a685-614a614a1588</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-03-15T11:05:51.550368+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>6612e217-f277-4eae-ad25-a0d179e6fa8b</PersonId> <Remarks>sample string 5</Remarks> <UserId>358fe4aa-88c9-41e6-9f76-039c421d1088</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>e446ee93-71fb-4bf4-b3b5-1eba31e78c35</d2p1:guid> <d2p1:guid>2851842f-20f4-448c-8343-d45f37bc6a2e</d2p1:guid> </UserRoleIds> </UserDetails>