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": "a8065536-0991-4fe2-a6fb-7abccdf9af93",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"460c2091-6927-4d78-8f37-8f53399e2066",
"0cbef50a-e672-4824-81f8-9682ccd2c7ea"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"a8065536-0991-4fe2-a6fb-7abccdf9af93","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["460c2091-6927-4d78-8f37-8f53399e2066","0cbef50a-e672-4824-81f8-9682ccd2c7ea"],"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>a8065536-0991-4fe2-a6fb-7abccdf9af93</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>460c2091-6927-4d78-8f37-8f53399e2066</d2p1:guid>
<d2p1:guid>0cbef50a-e672-4824-81f8-9682ccd2c7ea</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": "727539a0-369a-424e-a283-e47c4aa29a96",
"ClubId": "803ac9e9-0b49-4be7-8bae-469ff89b911e",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "de1acb5d-d03d-4724-9054-31950cc18ec7",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"93f9e584-06d7-430c-8c68-b11a6fe858c4",
"c1923c5c-4579-456b-ae60-7da96e45a7c0"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-08-11T15:58:23.3234199+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "727539a0-369a-424e-a283-e47c4aa29a96",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"727539a0-369a-424e-a283-e47c4aa29a96","ClubId":"803ac9e9-0b49-4be7-8bae-469ff89b911e","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"de1acb5d-d03d-4724-9054-31950cc18ec7","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["93f9e584-06d7-430c-8c68-b11a6fe858c4","c1923c5c-4579-456b-ae60-7da96e45a7c0"],"AccountState":7,"LastPasswordChangeOn":"2026-08-11T15:58:23.3234199+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"727539a0-369a-424e-a283-e47c4aa29a96","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">727539a0-369a-424e-a283-e47c4aa29a96</Id>
<AccountState>7</AccountState>
<ClubId>803ac9e9-0b49-4be7-8bae-469ff89b911e</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-08-11T15:58:23.3234199+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>de1acb5d-d03d-4724-9054-31950cc18ec7</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>727539a0-369a-424e-a283-e47c4aa29a96</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>93f9e584-06d7-430c-8c68-b11a6fe858c4</d2p1:guid>
<d2p1:guid>c1923c5c-4579-456b-ae60-7da96e45a7c0</d2p1:guid>
</UserRoleIds>
</UserDetails>