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": "8d64a93d-dc97-4fef-9b7f-1a4a310a2f00",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"45a438fa-a5e8-4461-bac7-5bfd189de949",
"19daea57-1b5e-4472-8e3e-485414a917d8"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"8d64a93d-dc97-4fef-9b7f-1a4a310a2f00","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["45a438fa-a5e8-4461-bac7-5bfd189de949","19daea57-1b5e-4472-8e3e-485414a917d8"],"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>8d64a93d-dc97-4fef-9b7f-1a4a310a2f00</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>45a438fa-a5e8-4461-bac7-5bfd189de949</d2p1:guid>
<d2p1:guid>19daea57-1b5e-4472-8e3e-485414a917d8</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": "57ab2515-0814-4381-921c-7ddbe733e554",
"ClubId": "251f9b05-3f50-478c-9383-018e7c45ecaf",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "3f331257-8944-4a7e-a9ba-8b6fc2740da2",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"c79fbc9f-d2bb-4f9b-b55a-ee85702c07de",
"6fc8e44e-7a42-49c1-adef-96ab8b11c8e9"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-29T13:10:12.0582606+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "57ab2515-0814-4381-921c-7ddbe733e554",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"57ab2515-0814-4381-921c-7ddbe733e554","ClubId":"251f9b05-3f50-478c-9383-018e7c45ecaf","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"3f331257-8944-4a7e-a9ba-8b6fc2740da2","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["c79fbc9f-d2bb-4f9b-b55a-ee85702c07de","6fc8e44e-7a42-49c1-adef-96ab8b11c8e9"],"AccountState":7,"LastPasswordChangeOn":"2025-11-29T13:10:12.0582606+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"57ab2515-0814-4381-921c-7ddbe733e554","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">57ab2515-0814-4381-921c-7ddbe733e554</Id>
<AccountState>7</AccountState>
<ClubId>251f9b05-3f50-478c-9383-018e7c45ecaf</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-29T13:10:12.0582606+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>3f331257-8944-4a7e-a9ba-8b6fc2740da2</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>57ab2515-0814-4381-921c-7ddbe733e554</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>c79fbc9f-d2bb-4f9b-b55a-ee85702c07de</d2p1:guid>
<d2p1:guid>6fc8e44e-7a42-49c1-adef-96ab8b11c8e9</d2p1:guid>
</UserRoleIds>
</UserDetails>