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": "914b4ef9-94ef-43bf-bbfb-faf89a2811b0",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"063f9027-503f-41f8-a2fa-f2fce7baf68f",
"fa0f811f-d639-4666-ae57-c8a8032f9c7a"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"914b4ef9-94ef-43bf-bbfb-faf89a2811b0","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["063f9027-503f-41f8-a2fa-f2fce7baf68f","fa0f811f-d639-4666-ae57-c8a8032f9c7a"],"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>914b4ef9-94ef-43bf-bbfb-faf89a2811b0</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>063f9027-503f-41f8-a2fa-f2fce7baf68f</d2p1:guid>
<d2p1:guid>fa0f811f-d639-4666-ae57-c8a8032f9c7a</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": "044eb6a6-d17d-437a-ac9a-29d8798193d9",
"ClubId": "30afa20c-5627-401d-ac5d-b1063e4983df",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "658756fd-d2ec-4519-9cc8-38ee52d9d61b",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"82e96337-94ed-4934-a7f3-e0f84ec30386",
"09a83450-eb94-4cb9-af94-8ff173337629"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-10-11T02:52:47.6934087+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "044eb6a6-d17d-437a-ac9a-29d8798193d9",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"044eb6a6-d17d-437a-ac9a-29d8798193d9","ClubId":"30afa20c-5627-401d-ac5d-b1063e4983df","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"658756fd-d2ec-4519-9cc8-38ee52d9d61b","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["82e96337-94ed-4934-a7f3-e0f84ec30386","09a83450-eb94-4cb9-af94-8ff173337629"],"AccountState":7,"LastPasswordChangeOn":"2026-10-11T02:52:47.6934087+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"044eb6a6-d17d-437a-ac9a-29d8798193d9","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">044eb6a6-d17d-437a-ac9a-29d8798193d9</Id>
<AccountState>7</AccountState>
<ClubId>30afa20c-5627-401d-ac5d-b1063e4983df</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-10-11T02:52:47.6934087+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>658756fd-d2ec-4519-9cc8-38ee52d9d61b</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>044eb6a6-d17d-437a-ac9a-29d8798193d9</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>82e96337-94ed-4934-a7f3-e0f84ec30386</d2p1:guid>
<d2p1:guid>09a83450-eb94-4cb9-af94-8ff173337629</d2p1:guid>
</UserRoleIds>
</UserDetails>