GET api/v1/users/name/{username}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
username | string |
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": "8d2bc5f5-c574-484b-8c39-1dd979afab54", "ClubId": "62602809-52b9-41be-9f81-fce8bba54c9c", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "6d64e50b-baa2-4289-9ecd-c249beb4c8b6", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "2d624e99-4d42-4c5c-b504-04a873c98a5c", "dd32035f-6fa9-4a25-85d5-1f884f42ad87" ], "AccountState": 7, "LastPasswordChangeOn": "2024-10-29T15:42:49.6832451+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "8d2bc5f5-c574-484b-8c39-1dd979afab54", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"8d2bc5f5-c574-484b-8c39-1dd979afab54","ClubId":"62602809-52b9-41be-9f81-fce8bba54c9c","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6d64e50b-baa2-4289-9ecd-c249beb4c8b6","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["2d624e99-4d42-4c5c-b504-04a873c98a5c","dd32035f-6fa9-4a25-85d5-1f884f42ad87"],"AccountState":7,"LastPasswordChangeOn":"2024-10-29T15:42:49.6832451+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"8d2bc5f5-c574-484b-8c39-1dd979afab54","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">8d2bc5f5-c574-484b-8c39-1dd979afab54</Id> <AccountState>7</AccountState> <ClubId>62602809-52b9-41be-9f81-fce8bba54c9c</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-10-29T15:42:49.6832451+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>6d64e50b-baa2-4289-9ecd-c249beb4c8b6</PersonId> <Remarks>sample string 5</Remarks> <UserId>8d2bc5f5-c574-484b-8c39-1dd979afab54</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>2d624e99-4d42-4c5c-b504-04a873c98a5c</d2p1:guid> <d2p1:guid>dd32035f-6fa9-4a25-85d5-1f884f42ad87</d2p1:guid> </UserRoleIds> </UserDetails>