POST api/v1/users

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
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.
EmailConfirmationLink	string	Required String length: inclusive between 0 and 256

Request Formats

application/json, text/json

Sample:

{
  "FriendlyName": "sample string 1",
  "NotificationEmail": "sample string 2",
  "PersonId": "96d71013-f372-4ea1-9e6d-f311bb01f8c0",
  "Remarks": "sample string 3",
  "UserName": "sample string 4",
  "UserRoleIds": [
    "190b8c57-9d52-4b53-af57-740e7375673f",
    "80d077d9-3eec-4b9f-a4a4-d02fb22da847"
  ],
  "EmailConfirmationLink": "sample string 5"
}

text/html

Sample:

{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"96d71013-f372-4ea1-9e6d-f311bb01f8c0","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["190b8c57-9d52-4b53-af57-740e7375673f","80d077d9-3eec-4b9f-a4a4-d02fb22da847"],"EmailConfirmationLink":"sample string 5"}

application/xml, text/xml

Sample:

<UserRegistrationDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
  <EmailConfirmationLink>sample string 5</EmailConfirmationLink>
  <FriendlyName>sample string 1</FriendlyName>
  <NotificationEmail>sample string 2</NotificationEmail>
  <PersonId>96d71013-f372-4ea1-9e6d-f311bb01f8c0</PersonId>
  <Remarks>sample string 3</Remarks>
  <UserName>sample string 4</UserName>
  <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>190b8c57-9d52-4b53-af57-740e7375673f</d2p1:guid>
    <d2p1:guid>80d077d9-3eec-4b9f-a4a4-d02fb22da847</d2p1:guid>
  </UserRoleIds>
</UserRegistrationDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserDetails

Name	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": "442d1141-c7f7-45db-a190-3339c6c2d160",
  "ClubId": "7da2f5dc-0b85-48e6-ba08-ce9d7328ca36",
  "FriendlyName": "sample string 3",
  "NotificationEmail": "sample string 4",
  "PersonId": "1bfe4306-ca34-47fe-a81c-cf91b4a22a06",
  "Remarks": "sample string 5",
  "UserName": "sample string 6",
  "UserRoleIds": [
    "af16d12c-bde5-46c1-a73c-55a10bb58c17",
    "3f2519c7-d21c-4441-b329-d5018e1a5d3a"
  ],
  "AccountState": 7,
  "LastPasswordChangeOn": "2023-02-06T16:28:32.3902336+01:00",
  "ForcePasswordChangeNextLogon": true,
  "EmailConfirmed": true,
  "LanguageId": 10,
  "Id": "442d1141-c7f7-45db-a190-3339c6c2d160",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:

{"UserId":"442d1141-c7f7-45db-a190-3339c6c2d160","ClubId":"7da2f5dc-0b85-48e6-ba08-ce9d7328ca36","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"1bfe4306-ca34-47fe-a81c-cf91b4a22a06","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["af16d12c-bde5-46c1-a73c-55a10bb58c17","3f2519c7-d21c-4441-b329-d5018e1a5d3a"],"AccountState":7,"LastPasswordChangeOn":"2023-02-06T16:28:32.3902336+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"442d1141-c7f7-45db-a190-3339c6c2d160","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">442d1141-c7f7-45db-a190-3339c6c2d160</Id>
  <AccountState>7</AccountState>
  <ClubId>7da2f5dc-0b85-48e6-ba08-ce9d7328ca36</ClubId>
  <EmailConfirmed>true</EmailConfirmed>
  <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
  <FriendlyName>sample string 3</FriendlyName>
  <LanguageId>10</LanguageId>
  <LastPasswordChangeOn>2023-02-06T16:28:32.3902336+01:00</LastPasswordChangeOn>
  <NotificationEmail>sample string 4</NotificationEmail>
  <PersonId>1bfe4306-ca34-47fe-a81c-cf91b4a22a06</PersonId>
  <Remarks>sample string 5</Remarks>
  <UserId>442d1141-c7f7-45db-a190-3339c6c2d160</UserId>
  <UserName>sample string 6</UserName>
  <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>af16d12c-bde5-46c1-a73c-55a10bb58c17</d2p1:guid>
    <d2p1:guid>3f2519c7-d21c-4441-b329-d5018e1a5d3a</d2p1:guid>
  </UserRoleIds>
</UserDetails>