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": "fd0d4a92-353a-4db4-81e1-7a79de187d44",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"9ef2d34e-c2a6-4312-8ab5-d5192c89d080",
"eb961160-eaad-424f-ab75-19d131844a1e"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"fd0d4a92-353a-4db4-81e1-7a79de187d44","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["9ef2d34e-c2a6-4312-8ab5-d5192c89d080","eb961160-eaad-424f-ab75-19d131844a1e"],"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>fd0d4a92-353a-4db4-81e1-7a79de187d44</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>9ef2d34e-c2a6-4312-8ab5-d5192c89d080</d2p1:guid>
<d2p1:guid>eb961160-eaad-424f-ab75-19d131844a1e</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": "0c8dccbd-1336-4c2b-89cd-b2a982c98ad7",
"ClubId": "b4fda7b1-d826-4fe0-96a3-1ca9cffb11a6",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "4b360592-aeb2-4b12-a3fc-912a22e716af",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"783bb0bf-4e6d-4b6a-8c4a-a053896b175f",
"ad1c4e07-0905-4949-a8a8-dfdc2dc8eead"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-03T06:11:56.375655+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "0c8dccbd-1336-4c2b-89cd-b2a982c98ad7",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"0c8dccbd-1336-4c2b-89cd-b2a982c98ad7","ClubId":"b4fda7b1-d826-4fe0-96a3-1ca9cffb11a6","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4b360592-aeb2-4b12-a3fc-912a22e716af","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["783bb0bf-4e6d-4b6a-8c4a-a053896b175f","ad1c4e07-0905-4949-a8a8-dfdc2dc8eead"],"AccountState":7,"LastPasswordChangeOn":"2025-12-03T06:11:56.375655+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"0c8dccbd-1336-4c2b-89cd-b2a982c98ad7","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">0c8dccbd-1336-4c2b-89cd-b2a982c98ad7</Id>
<AccountState>7</AccountState>
<ClubId>b4fda7b1-d826-4fe0-96a3-1ca9cffb11a6</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-03T06:11:56.375655+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>4b360592-aeb2-4b12-a3fc-912a22e716af</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>0c8dccbd-1336-4c2b-89cd-b2a982c98ad7</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>783bb0bf-4e6d-4b6a-8c4a-a053896b175f</d2p1:guid>
<d2p1:guid>ad1c4e07-0905-4949-a8a8-dfdc2dc8eead</d2p1:guid>
</UserRoleIds>
</UserDetails>