POST api/v1/users
Request Information
URI Parameters
None.
Body Parameters
UserRegistrationDetails| Name | Description | 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": "79271a24-a110-4bae-a04e-9b556239c615",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"78e69425-4004-4681-ba92-3be004287a9b",
"705b0de8-e88b-4286-b0a8-78b18d4c092a"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"79271a24-a110-4bae-a04e-9b556239c615","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["78e69425-4004-4681-ba92-3be004287a9b","705b0de8-e88b-4286-b0a8-78b18d4c092a"],"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>79271a24-a110-4bae-a04e-9b556239c615</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>78e69425-4004-4681-ba92-3be004287a9b</d2p1:guid>
<d2p1:guid>705b0de8-e88b-4286-b0a8-78b18d4c092a</d2p1:guid>
</UserRoleIds>
</UserRegistrationDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
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": "cad9309b-39b8-4980-bf0a-bceac4541cba",
"ClubId": "63ca9d86-65d3-4090-b1d1-447641205ca0",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "27e0cfbf-491b-4be2-90a9-088988127d68",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"17c35541-6cc1-4053-94e9-3d3fa5060ce1",
"e4742243-d767-4b5a-857b-1af08666c2ab"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-27T00:00:08.72693+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "cad9309b-39b8-4980-bf0a-bceac4541cba",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"cad9309b-39b8-4980-bf0a-bceac4541cba","ClubId":"63ca9d86-65d3-4090-b1d1-447641205ca0","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"27e0cfbf-491b-4be2-90a9-088988127d68","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["17c35541-6cc1-4053-94e9-3d3fa5060ce1","e4742243-d767-4b5a-857b-1af08666c2ab"],"AccountState":7,"LastPasswordChangeOn":"2026-02-27T00:00:08.72693+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"cad9309b-39b8-4980-bf0a-bceac4541cba","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">cad9309b-39b8-4980-bf0a-bceac4541cba</Id>
<AccountState>7</AccountState>
<ClubId>63ca9d86-65d3-4090-b1d1-447641205ca0</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-27T00:00:08.72693+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>27e0cfbf-491b-4be2-90a9-088988127d68</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>cad9309b-39b8-4980-bf0a-bceac4541cba</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>17c35541-6cc1-4053-94e9-3d3fa5060ce1</d2p1:guid>
<d2p1:guid>e4742243-d767-4b5a-857b-1af08666c2ab</d2p1:guid>
</UserRoleIds>
</UserDetails>