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": "259054f3-e00d-484b-bee4-7a655e73771e",
"ClubId": "ed862f5c-9ab9-4555-92d8-4d5c91fa35d1",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "eeb08ad8-2f30-4e6b-886c-8a7fdcb08685",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"26c8ce39-ea61-410e-8a78-b3e7c1438f84",
"d6fdbf33-cf90-472c-b5c7-901315c604ff"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-23T03:50:21.1816181+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "259054f3-e00d-484b-bee4-7a655e73771e",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"259054f3-e00d-484b-bee4-7a655e73771e","ClubId":"ed862f5c-9ab9-4555-92d8-4d5c91fa35d1","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"eeb08ad8-2f30-4e6b-886c-8a7fdcb08685","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["26c8ce39-ea61-410e-8a78-b3e7c1438f84","d6fdbf33-cf90-472c-b5c7-901315c604ff"],"AccountState":7,"LastPasswordChangeOn":"2025-12-23T03:50:21.1816181+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"259054f3-e00d-484b-bee4-7a655e73771e","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">259054f3-e00d-484b-bee4-7a655e73771e</Id>
<AccountState>7</AccountState>
<ClubId>ed862f5c-9ab9-4555-92d8-4d5c91fa35d1</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-23T03:50:21.1816181+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>eeb08ad8-2f30-4e6b-886c-8a7fdcb08685</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>259054f3-e00d-484b-bee4-7a655e73771e</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>26c8ce39-ea61-410e-8a78-b3e7c1438f84</d2p1:guid>
<d2p1:guid>d6fdbf33-cf90-472c-b5c7-901315c604ff</d2p1:guid>
</UserRoleIds>
</UserDetails>