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": "443f2e1d-c9dc-45d8-85a4-2110d3f7cdee",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"edbbe911-a291-483e-ac8a-453769f7f4d4",
"be7c618c-a2ad-40cc-affb-936691c3ea3b"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"443f2e1d-c9dc-45d8-85a4-2110d3f7cdee","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["edbbe911-a291-483e-ac8a-453769f7f4d4","be7c618c-a2ad-40cc-affb-936691c3ea3b"],"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>443f2e1d-c9dc-45d8-85a4-2110d3f7cdee</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>edbbe911-a291-483e-ac8a-453769f7f4d4</d2p1:guid>
<d2p1:guid>be7c618c-a2ad-40cc-affb-936691c3ea3b</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": "1ca7902c-67d5-4af3-86ba-15734f3b2ee9",
"ClubId": "17eb9cac-6294-4842-a53e-6227d4b34400",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "1582336a-4569-425d-bf6b-23842930e65e",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"5bc50721-2068-47ab-960f-1e0088143536",
"615dcca6-8e3e-457f-b472-ea15680b8403"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-04-13T08:40:26.0123357+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "1ca7902c-67d5-4af3-86ba-15734f3b2ee9",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"1ca7902c-67d5-4af3-86ba-15734f3b2ee9","ClubId":"17eb9cac-6294-4842-a53e-6227d4b34400","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"1582336a-4569-425d-bf6b-23842930e65e","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["5bc50721-2068-47ab-960f-1e0088143536","615dcca6-8e3e-457f-b472-ea15680b8403"],"AccountState":7,"LastPasswordChangeOn":"2026-04-13T08:40:26.0123357+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"1ca7902c-67d5-4af3-86ba-15734f3b2ee9","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">1ca7902c-67d5-4af3-86ba-15734f3b2ee9</Id>
<AccountState>7</AccountState>
<ClubId>17eb9cac-6294-4842-a53e-6227d4b34400</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-04-13T08:40:26.0123357+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>1582336a-4569-425d-bf6b-23842930e65e</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>1ca7902c-67d5-4af3-86ba-15734f3b2ee9</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>5bc50721-2068-47ab-960f-1e0088143536</d2p1:guid>
<d2p1:guid>615dcca6-8e3e-457f-b472-ea15680b8403</d2p1:guid>
</UserRoleIds>
</UserDetails>