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": "faa7145e-fd6f-4bfd-b1c4-e36908874c85",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"588a533b-382b-438e-99ae-c541c8b306e1",
"671d9673-3bca-445d-8f2d-96ce8ee50e67"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"faa7145e-fd6f-4bfd-b1c4-e36908874c85","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["588a533b-382b-438e-99ae-c541c8b306e1","671d9673-3bca-445d-8f2d-96ce8ee50e67"],"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>faa7145e-fd6f-4bfd-b1c4-e36908874c85</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>588a533b-382b-438e-99ae-c541c8b306e1</d2p1:guid>
<d2p1:guid>671d9673-3bca-445d-8f2d-96ce8ee50e67</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": "171f568c-b4e8-473d-9bcd-fffe4cd2f2e8",
"ClubId": "ac0af4fe-d353-4169-99a8-2e9251a6fd92",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "6628115a-551b-4b2d-bcd2-0cc061646ec2",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"6d5c485f-383c-4fa3-889b-6a7f9841525a",
"1f0e3a05-f143-4531-b3b7-2e19fadb77c0"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-28T17:42:46.8551331+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "171f568c-b4e8-473d-9bcd-fffe4cd2f2e8",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"171f568c-b4e8-473d-9bcd-fffe4cd2f2e8","ClubId":"ac0af4fe-d353-4169-99a8-2e9251a6fd92","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6628115a-551b-4b2d-bcd2-0cc061646ec2","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["6d5c485f-383c-4fa3-889b-6a7f9841525a","1f0e3a05-f143-4531-b3b7-2e19fadb77c0"],"AccountState":7,"LastPasswordChangeOn":"2025-11-28T17:42:46.8551331+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"171f568c-b4e8-473d-9bcd-fffe4cd2f2e8","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">171f568c-b4e8-473d-9bcd-fffe4cd2f2e8</Id>
<AccountState>7</AccountState>
<ClubId>ac0af4fe-d353-4169-99a8-2e9251a6fd92</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-28T17:42:46.8551331+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>6628115a-551b-4b2d-bcd2-0cc061646ec2</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>171f568c-b4e8-473d-9bcd-fffe4cd2f2e8</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6d5c485f-383c-4fa3-889b-6a7f9841525a</d2p1:guid>
<d2p1:guid>1f0e3a05-f143-4531-b3b7-2e19fadb77c0</d2p1:guid>
</UserRoleIds>
</UserDetails>