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": "281a7011-fcfa-460c-9843-19d6e936da2a",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"b2b8f508-7323-4f23-a37c-b10564494080",
"9f2e66d3-0776-42c1-9102-59b3bda9faab"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"281a7011-fcfa-460c-9843-19d6e936da2a","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["b2b8f508-7323-4f23-a37c-b10564494080","9f2e66d3-0776-42c1-9102-59b3bda9faab"],"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>281a7011-fcfa-460c-9843-19d6e936da2a</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>b2b8f508-7323-4f23-a37c-b10564494080</d2p1:guid>
<d2p1:guid>9f2e66d3-0776-42c1-9102-59b3bda9faab</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": "60c14e44-ca37-4a21-b36d-e02b1284ac99",
"ClubId": "00027669-b3b5-4faa-8419-bf2a60a8bdac",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "3ce60824-4468-4d92-aa2d-c1fbce5f2cd3",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"f8842bde-59cf-49f2-9e62-3203e390e296",
"ca557774-b33c-4839-a7ff-a7f0eb5ba069"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-01T05:24:26.8600259+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "60c14e44-ca37-4a21-b36d-e02b1284ac99",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"60c14e44-ca37-4a21-b36d-e02b1284ac99","ClubId":"00027669-b3b5-4faa-8419-bf2a60a8bdac","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"3ce60824-4468-4d92-aa2d-c1fbce5f2cd3","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["f8842bde-59cf-49f2-9e62-3203e390e296","ca557774-b33c-4839-a7ff-a7f0eb5ba069"],"AccountState":7,"LastPasswordChangeOn":"2025-12-01T05:24:26.8600259+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"60c14e44-ca37-4a21-b36d-e02b1284ac99","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">60c14e44-ca37-4a21-b36d-e02b1284ac99</Id>
<AccountState>7</AccountState>
<ClubId>00027669-b3b5-4faa-8419-bf2a60a8bdac</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-01T05:24:26.8600259+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>3ce60824-4468-4d92-aa2d-c1fbce5f2cd3</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>60c14e44-ca37-4a21-b36d-e02b1284ac99</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f8842bde-59cf-49f2-9e62-3203e390e296</d2p1:guid>
<d2p1:guid>ca557774-b33c-4839-a7ff-a7f0eb5ba069</d2p1:guid>
</UserRoleIds>
</UserDetails>