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": "75b5aef7-46dd-4728-8e43-4411e49aa04e",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"bc4f3332-c107-4b76-8f7c-bd26c90a7706",
"aef25106-245b-4ecc-9a57-692e61b1714e"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"75b5aef7-46dd-4728-8e43-4411e49aa04e","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["bc4f3332-c107-4b76-8f7c-bd26c90a7706","aef25106-245b-4ecc-9a57-692e61b1714e"],"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>75b5aef7-46dd-4728-8e43-4411e49aa04e</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>bc4f3332-c107-4b76-8f7c-bd26c90a7706</d2p1:guid>
<d2p1:guid>aef25106-245b-4ecc-9a57-692e61b1714e</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": "6ad27ce8-2691-4f66-aa84-edad1de354d4",
"ClubId": "ed657709-6bc1-48f7-a756-3c843671145e",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "f2b96859-df57-41d6-9cf2-b5c0cde6c59c",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"236218a8-858e-4e3d-bb8f-14a1d976799c",
"68abd9b3-9f23-4532-a343-fd2620b9e491"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-05T03:25:38.8912819+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "6ad27ce8-2691-4f66-aa84-edad1de354d4",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"6ad27ce8-2691-4f66-aa84-edad1de354d4","ClubId":"ed657709-6bc1-48f7-a756-3c843671145e","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"f2b96859-df57-41d6-9cf2-b5c0cde6c59c","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["236218a8-858e-4e3d-bb8f-14a1d976799c","68abd9b3-9f23-4532-a343-fd2620b9e491"],"AccountState":7,"LastPasswordChangeOn":"2025-12-05T03:25:38.8912819+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"6ad27ce8-2691-4f66-aa84-edad1de354d4","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">6ad27ce8-2691-4f66-aa84-edad1de354d4</Id>
<AccountState>7</AccountState>
<ClubId>ed657709-6bc1-48f7-a756-3c843671145e</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-05T03:25:38.8912819+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>f2b96859-df57-41d6-9cf2-b5c0cde6c59c</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>6ad27ce8-2691-4f66-aa84-edad1de354d4</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>236218a8-858e-4e3d-bb8f-14a1d976799c</d2p1:guid>
<d2p1:guid>68abd9b3-9f23-4532-a343-fd2620b9e491</d2p1:guid>
</UserRoleIds>
</UserDetails>