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": "27f11f57-072b-4f60-83c4-a349c826269d",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"78260f2a-77e7-4530-b05a-26a1db53227c",
"4a1c8e67-260a-4557-b2f8-61354affce00"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"27f11f57-072b-4f60-83c4-a349c826269d","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["78260f2a-77e7-4530-b05a-26a1db53227c","4a1c8e67-260a-4557-b2f8-61354affce00"],"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>27f11f57-072b-4f60-83c4-a349c826269d</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>78260f2a-77e7-4530-b05a-26a1db53227c</d2p1:guid>
<d2p1:guid>4a1c8e67-260a-4557-b2f8-61354affce00</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": "761e2b00-a519-4b41-b719-7a120647fb9c",
"ClubId": "bb2ad730-de55-43a7-ab62-07bc0d4af35e",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "59530bef-e7f4-472a-aad4-467702e3f59f",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"78a3c5c4-2105-4117-a4bc-1cca35af6a01",
"f767ab93-004f-46fc-90a6-3108a85ec947"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-26T13:20:35.0895177+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "761e2b00-a519-4b41-b719-7a120647fb9c",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"761e2b00-a519-4b41-b719-7a120647fb9c","ClubId":"bb2ad730-de55-43a7-ab62-07bc0d4af35e","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"59530bef-e7f4-472a-aad4-467702e3f59f","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["78a3c5c4-2105-4117-a4bc-1cca35af6a01","f767ab93-004f-46fc-90a6-3108a85ec947"],"AccountState":7,"LastPasswordChangeOn":"2025-11-26T13:20:35.0895177+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"761e2b00-a519-4b41-b719-7a120647fb9c","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">761e2b00-a519-4b41-b719-7a120647fb9c</Id>
<AccountState>7</AccountState>
<ClubId>bb2ad730-de55-43a7-ab62-07bc0d4af35e</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-26T13:20:35.0895177+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>59530bef-e7f4-472a-aad4-467702e3f59f</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>761e2b00-a519-4b41-b719-7a120647fb9c</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>78a3c5c4-2105-4117-a4bc-1cca35af6a01</d2p1:guid>
<d2p1:guid>f767ab93-004f-46fc-90a6-3108a85ec947</d2p1:guid>
</UserRoleIds>
</UserDetails>