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": "1415842d-2e97-4c16-bd79-70ff2a7f761b", "ClubId": "cd509b22-e311-4585-92f2-2eaca0ed9710", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "efb1a6ac-1a4b-4a75-86ae-cd41bab8c59f", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "0ef2d35f-2fcf-456b-959f-dac1f7b5b9b3", "ddaffeea-5d7d-4751-bd8c-4f848b14c0e5" ], "AccountState": 7, "LastPasswordChangeOn": "2024-05-16T10:58:47.849255+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "1415842d-2e97-4c16-bd79-70ff2a7f761b", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"1415842d-2e97-4c16-bd79-70ff2a7f761b","ClubId":"cd509b22-e311-4585-92f2-2eaca0ed9710","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"efb1a6ac-1a4b-4a75-86ae-cd41bab8c59f","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["0ef2d35f-2fcf-456b-959f-dac1f7b5b9b3","ddaffeea-5d7d-4751-bd8c-4f848b14c0e5"],"AccountState":7,"LastPasswordChangeOn":"2024-05-16T10:58:47.849255+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"1415842d-2e97-4c16-bd79-70ff2a7f761b","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">1415842d-2e97-4c16-bd79-70ff2a7f761b</Id> <AccountState>7</AccountState> <ClubId>cd509b22-e311-4585-92f2-2eaca0ed9710</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-05-16T10:58:47.849255+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>efb1a6ac-1a4b-4a75-86ae-cd41bab8c59f</PersonId> <Remarks>sample string 5</Remarks> <UserId>1415842d-2e97-4c16-bd79-70ff2a7f761b</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>0ef2d35f-2fcf-456b-959f-dac1f7b5b9b3</d2p1:guid> <d2p1:guid>ddaffeea-5d7d-4751-bd8c-4f848b14c0e5</d2p1:guid> </UserRoleIds> </UserDetails>