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": "e70e3a52-f1e8-4970-885a-3d04832417e0",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"c6c1bc85-9ee1-4b81-9e90-2f336ae729f8",
"1eb174c0-9568-45f8-8b78-f7c3a5c9dcd9"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"e70e3a52-f1e8-4970-885a-3d04832417e0","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["c6c1bc85-9ee1-4b81-9e90-2f336ae729f8","1eb174c0-9568-45f8-8b78-f7c3a5c9dcd9"],"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>e70e3a52-f1e8-4970-885a-3d04832417e0</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c6c1bc85-9ee1-4b81-9e90-2f336ae729f8</d2p1:guid>
<d2p1:guid>1eb174c0-9568-45f8-8b78-f7c3a5c9dcd9</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": "c17a0496-700b-48b6-984d-6a705cb261d6",
"ClubId": "62390b96-5071-42e4-9a3a-c78603c96d86",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "4f78d5c7-3331-4d24-a1fa-ed18ef8ab0d7",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"e4afa38c-94e8-410b-acae-c4eedec7f30d",
"e50d409a-c1d1-471c-9ff6-f0046d8bb1d9"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-07-12T18:06:50.1288249+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c17a0496-700b-48b6-984d-6a705cb261d6",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c17a0496-700b-48b6-984d-6a705cb261d6","ClubId":"62390b96-5071-42e4-9a3a-c78603c96d86","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4f78d5c7-3331-4d24-a1fa-ed18ef8ab0d7","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["e4afa38c-94e8-410b-acae-c4eedec7f30d","e50d409a-c1d1-471c-9ff6-f0046d8bb1d9"],"AccountState":7,"LastPasswordChangeOn":"2026-07-12T18:06:50.1288249+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c17a0496-700b-48b6-984d-6a705cb261d6","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">c17a0496-700b-48b6-984d-6a705cb261d6</Id>
<AccountState>7</AccountState>
<ClubId>62390b96-5071-42e4-9a3a-c78603c96d86</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-07-12T18:06:50.1288249+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>4f78d5c7-3331-4d24-a1fa-ed18ef8ab0d7</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c17a0496-700b-48b6-984d-6a705cb261d6</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e4afa38c-94e8-410b-acae-c4eedec7f30d</d2p1:guid>
<d2p1:guid>e50d409a-c1d1-471c-9ff6-f0046d8bb1d9</d2p1:guid>
</UserRoleIds>
</UserDetails>