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": "e0007b4f-6e63-4357-a330-727d74a73ffa",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"fa7fc0a3-23bc-4768-bcd5-08fb7ca1bf1d",
"480703f8-e952-4273-b128-aa4e4e4c9462"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"e0007b4f-6e63-4357-a330-727d74a73ffa","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["fa7fc0a3-23bc-4768-bcd5-08fb7ca1bf1d","480703f8-e952-4273-b128-aa4e4e4c9462"],"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>e0007b4f-6e63-4357-a330-727d74a73ffa</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>fa7fc0a3-23bc-4768-bcd5-08fb7ca1bf1d</d2p1:guid>
<d2p1:guid>480703f8-e952-4273-b128-aa4e4e4c9462</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": "463bcd14-186d-44d8-85ce-dd74592bf208",
"ClubId": "ee1c580d-181e-4432-a5ee-116b722b3911",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "9240a108-101e-49be-91b6-cbb7c7335ace",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"eb58ca2e-1773-46d4-9794-fd0bc97b99e5",
"4229c261-1a63-4d6b-8ccf-800cc48f5e1f"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-28T01:54:23.2770088+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "463bcd14-186d-44d8-85ce-dd74592bf208",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"463bcd14-186d-44d8-85ce-dd74592bf208","ClubId":"ee1c580d-181e-4432-a5ee-116b722b3911","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"9240a108-101e-49be-91b6-cbb7c7335ace","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["eb58ca2e-1773-46d4-9794-fd0bc97b99e5","4229c261-1a63-4d6b-8ccf-800cc48f5e1f"],"AccountState":7,"LastPasswordChangeOn":"2025-11-28T01:54:23.2770088+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"463bcd14-186d-44d8-85ce-dd74592bf208","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">463bcd14-186d-44d8-85ce-dd74592bf208</Id>
<AccountState>7</AccountState>
<ClubId>ee1c580d-181e-4432-a5ee-116b722b3911</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-28T01:54:23.2770088+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>9240a108-101e-49be-91b6-cbb7c7335ace</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>463bcd14-186d-44d8-85ce-dd74592bf208</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>eb58ca2e-1773-46d4-9794-fd0bc97b99e5</d2p1:guid>
<d2p1:guid>4229c261-1a63-4d6b-8ccf-800cc48f5e1f</d2p1:guid>
</UserRoleIds>
</UserDetails>