GET api/v1/users/name/{username}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
username

string

Required

Body Parameters

None.

Response Information

Resource Description

UserDetails
NameDescriptionTypeAdditional 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": "af627bca-26c6-4ad5-8778-1d40da506120",
  "ClubId": "9f143a17-684f-4b28-99aa-b3e13555fde6",
  "FriendlyName": "sample string 3",
  "NotificationEmail": "sample string 4",
  "PersonId": "4ae54911-af52-41b4-ad80-61d8953cff3d",
  "Remarks": "sample string 5",
  "UserName": "sample string 6",
  "UserRoleIds": [
    "95c78d4d-50c0-430e-9cd7-9a6652023275",
    "57baa9d8-4dd9-4612-ab7f-3f5588e3c190"
  ],
  "AccountState": 7,
  "LastPasswordChangeOn": "2024-03-29T07:23:40.1125245+01:00",
  "ForcePasswordChangeNextLogon": true,
  "EmailConfirmed": true,
  "LanguageId": 10,
  "Id": "af627bca-26c6-4ad5-8778-1d40da506120",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"UserId":"af627bca-26c6-4ad5-8778-1d40da506120","ClubId":"9f143a17-684f-4b28-99aa-b3e13555fde6","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4ae54911-af52-41b4-ad80-61d8953cff3d","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["95c78d4d-50c0-430e-9cd7-9a6652023275","57baa9d8-4dd9-4612-ab7f-3f5588e3c190"],"AccountState":7,"LastPasswordChangeOn":"2024-03-29T07:23:40.1125245+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"af627bca-26c6-4ad5-8778-1d40da506120","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">af627bca-26c6-4ad5-8778-1d40da506120</Id>
  <AccountState>7</AccountState>
  <ClubId>9f143a17-684f-4b28-99aa-b3e13555fde6</ClubId>
  <EmailConfirmed>true</EmailConfirmed>
  <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
  <FriendlyName>sample string 3</FriendlyName>
  <LanguageId>10</LanguageId>
  <LastPasswordChangeOn>2024-03-29T07:23:40.1125245+01:00</LastPasswordChangeOn>
  <NotificationEmail>sample string 4</NotificationEmail>
  <PersonId>4ae54911-af52-41b4-ad80-61d8953cff3d</PersonId>
  <Remarks>sample string 5</Remarks>
  <UserId>af627bca-26c6-4ad5-8778-1d40da506120</UserId>
  <UserName>sample string 6</UserName>
  <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>95c78d4d-50c0-430e-9cd7-9a6652023275</d2p1:guid>
    <d2p1:guid>57baa9d8-4dd9-4612-ab7f-3f5588e3c190</d2p1:guid>
  </UserRoleIds>
</UserDetails>