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
UserDetails| Name | 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": "6a257501-8e2b-4ae3-9845-05133dbd5a05",
"ClubId": "b49d326a-bddd-4379-89a6-6159baecee45",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "1c251a0a-58c4-4883-8129-2d6ab57e2806",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"cae5798d-52be-4ff4-b6e0-9d88c16122b3",
"4f910a71-8b8f-405b-88ed-7d5729a4c985"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-03-01T06:30:20.0852872+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "6a257501-8e2b-4ae3-9845-05133dbd5a05",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"6a257501-8e2b-4ae3-9845-05133dbd5a05","ClubId":"b49d326a-bddd-4379-89a6-6159baecee45","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"1c251a0a-58c4-4883-8129-2d6ab57e2806","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["cae5798d-52be-4ff4-b6e0-9d88c16122b3","4f910a71-8b8f-405b-88ed-7d5729a4c985"],"AccountState":7,"LastPasswordChangeOn":"2026-03-01T06:30:20.0852872+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"6a257501-8e2b-4ae3-9845-05133dbd5a05","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">6a257501-8e2b-4ae3-9845-05133dbd5a05</Id>
<AccountState>7</AccountState>
<ClubId>b49d326a-bddd-4379-89a6-6159baecee45</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-03-01T06:30:20.0852872+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>1c251a0a-58c4-4883-8129-2d6ab57e2806</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>6a257501-8e2b-4ae3-9845-05133dbd5a05</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>cae5798d-52be-4ff4-b6e0-9d88c16122b3</d2p1:guid>
<d2p1:guid>4f910a71-8b8f-405b-88ed-7d5729a4c985</d2p1:guid>
</UserRoleIds>
</UserDetails>