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": "46438313-a283-4e2a-afcd-59c47c3c00e6",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"a2ee2acf-5c20-4dd5-b52a-af6f8b91e729",
"52aa8dd9-00bb-492d-9d33-f610eca497a7"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"46438313-a283-4e2a-afcd-59c47c3c00e6","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["a2ee2acf-5c20-4dd5-b52a-af6f8b91e729","52aa8dd9-00bb-492d-9d33-f610eca497a7"],"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>46438313-a283-4e2a-afcd-59c47c3c00e6</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>a2ee2acf-5c20-4dd5-b52a-af6f8b91e729</d2p1:guid>
<d2p1:guid>52aa8dd9-00bb-492d-9d33-f610eca497a7</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": "992f5874-366b-42f3-906f-8a2ea0b06b8f",
"ClubId": "1b6ff859-94ea-41aa-a6c9-a1301a0d7728",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "6739fc2d-0c53-408a-81fe-0045b2c53780",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"32c8f558-f318-4d23-ac48-b44c5a3f7223",
"1685feb0-0139-4e48-a907-2437f5f2017b"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-30T20:53:58.7361648+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "992f5874-366b-42f3-906f-8a2ea0b06b8f",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"992f5874-366b-42f3-906f-8a2ea0b06b8f","ClubId":"1b6ff859-94ea-41aa-a6c9-a1301a0d7728","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6739fc2d-0c53-408a-81fe-0045b2c53780","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["32c8f558-f318-4d23-ac48-b44c5a3f7223","1685feb0-0139-4e48-a907-2437f5f2017b"],"AccountState":7,"LastPasswordChangeOn":"2025-11-30T20:53:58.7361648+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"992f5874-366b-42f3-906f-8a2ea0b06b8f","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">992f5874-366b-42f3-906f-8a2ea0b06b8f</Id>
<AccountState>7</AccountState>
<ClubId>1b6ff859-94ea-41aa-a6c9-a1301a0d7728</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-30T20:53:58.7361648+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>6739fc2d-0c53-408a-81fe-0045b2c53780</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>992f5874-366b-42f3-906f-8a2ea0b06b8f</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>32c8f558-f318-4d23-ac48-b44c5a3f7223</d2p1:guid>
<d2p1:guid>1685feb0-0139-4e48-a907-2437f5f2017b</d2p1:guid>
</UserRoleIds>
</UserDetails>