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": "1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f",
"ClubId": "e1df52b0-f8e2-473f-a5a0-47ddb1524f36",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "f8733f2b-5174-4c2c-8f68-a55a9ba2aec4",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"5b4101f7-66c7-4244-bfcb-ed4249a17bbd",
"98e62d46-6f12-4899-a36e-9e78f5ab87e8"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-08T05:33:59.6158517+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f","ClubId":"e1df52b0-f8e2-473f-a5a0-47ddb1524f36","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"f8733f2b-5174-4c2c-8f68-a55a9ba2aec4","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["5b4101f7-66c7-4244-bfcb-ed4249a17bbd","98e62d46-6f12-4899-a36e-9e78f5ab87e8"],"AccountState":7,"LastPasswordChangeOn":"2026-02-08T05:33:59.6158517+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f","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">1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f</Id>
<AccountState>7</AccountState>
<ClubId>e1df52b0-f8e2-473f-a5a0-47ddb1524f36</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-08T05:33:59.6158517+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>f8733f2b-5174-4c2c-8f68-a55a9ba2aec4</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>1559d4e1-7ec9-4f8b-bccf-a3d09f8b327f</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>5b4101f7-66c7-4244-bfcb-ed4249a17bbd</d2p1:guid>
<d2p1:guid>98e62d46-6f12-4899-a36e-9e78f5ab87e8</d2p1:guid>
</UserRoleIds>
</UserDetails>