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": "6673528b-b006-40ca-8243-e2ec79986669",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"42589dc4-b390-4dd3-ad34-7d10e7825063",
"14803f3b-f07b-4b8e-8596-cc8beb2c2465"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"6673528b-b006-40ca-8243-e2ec79986669","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["42589dc4-b390-4dd3-ad34-7d10e7825063","14803f3b-f07b-4b8e-8596-cc8beb2c2465"],"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>6673528b-b006-40ca-8243-e2ec79986669</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>42589dc4-b390-4dd3-ad34-7d10e7825063</d2p1:guid>
<d2p1:guid>14803f3b-f07b-4b8e-8596-cc8beb2c2465</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": "2d5360b0-bb1a-4ff7-8803-f776271a4a7b",
"ClubId": "e0edae63-3027-4a27-898b-3caeb74ed114",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "2ef07f8b-ecbc-4d86-94ee-c963c74e7708",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"7c518c23-cd85-4402-a047-3dafa6e0deec",
"4a65805d-e24e-4941-84ae-b61d66c5b27e"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-01T00:56:09.8151789+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "2d5360b0-bb1a-4ff7-8803-f776271a4a7b",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"2d5360b0-bb1a-4ff7-8803-f776271a4a7b","ClubId":"e0edae63-3027-4a27-898b-3caeb74ed114","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"2ef07f8b-ecbc-4d86-94ee-c963c74e7708","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["7c518c23-cd85-4402-a047-3dafa6e0deec","4a65805d-e24e-4941-84ae-b61d66c5b27e"],"AccountState":7,"LastPasswordChangeOn":"2025-11-01T00:56:09.8151789+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"2d5360b0-bb1a-4ff7-8803-f776271a4a7b","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">2d5360b0-bb1a-4ff7-8803-f776271a4a7b</Id>
<AccountState>7</AccountState>
<ClubId>e0edae63-3027-4a27-898b-3caeb74ed114</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-01T00:56:09.8151789+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>2ef07f8b-ecbc-4d86-94ee-c963c74e7708</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>2d5360b0-bb1a-4ff7-8803-f776271a4a7b</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>7c518c23-cd85-4402-a047-3dafa6e0deec</d2p1:guid>
<d2p1:guid>4a65805d-e24e-4941-84ae-b61d66c5b27e</d2p1:guid>
</UserRoleIds>
</UserDetails>