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": "ac670d8e-468a-42a6-9734-e2af7d7f69aa",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"f495ab47-8538-4fab-b893-8a481fe8def3",
"b1f4698b-dfdf-49cc-acea-356d97d9ded7"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"ac670d8e-468a-42a6-9734-e2af7d7f69aa","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["f495ab47-8538-4fab-b893-8a481fe8def3","b1f4698b-dfdf-49cc-acea-356d97d9ded7"],"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>ac670d8e-468a-42a6-9734-e2af7d7f69aa</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f495ab47-8538-4fab-b893-8a481fe8def3</d2p1:guid>
<d2p1:guid>b1f4698b-dfdf-49cc-acea-356d97d9ded7</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": "a864d34a-644d-481f-8c5d-768468730dc7",
"ClubId": "28a0c9d6-851a-4a0f-965f-5173ad582cec",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "48eec39f-dbdc-41b6-ba3a-537256c15197",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"fbe6be48-b69c-4226-bad3-d2c3229133af",
"0de5e613-8fe9-49a3-961d-fb43408b06d4"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-02T13:53:00.9850308+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "a864d34a-644d-481f-8c5d-768468730dc7",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"a864d34a-644d-481f-8c5d-768468730dc7","ClubId":"28a0c9d6-851a-4a0f-965f-5173ad582cec","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"48eec39f-dbdc-41b6-ba3a-537256c15197","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["fbe6be48-b69c-4226-bad3-d2c3229133af","0de5e613-8fe9-49a3-961d-fb43408b06d4"],"AccountState":7,"LastPasswordChangeOn":"2025-12-02T13:53:00.9850308+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"a864d34a-644d-481f-8c5d-768468730dc7","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">a864d34a-644d-481f-8c5d-768468730dc7</Id>
<AccountState>7</AccountState>
<ClubId>28a0c9d6-851a-4a0f-965f-5173ad582cec</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-02T13:53:00.9850308+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>48eec39f-dbdc-41b6-ba3a-537256c15197</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>a864d34a-644d-481f-8c5d-768468730dc7</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>fbe6be48-b69c-4226-bad3-d2c3229133af</d2p1:guid>
<d2p1:guid>0de5e613-8fe9-49a3-961d-fb43408b06d4</d2p1:guid>
</UserRoleIds>
</UserDetails>