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": "5ce16acf-022a-4869-94d6-27f17b5b7f47",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"4df53d1e-3f88-4b24-9daf-58a7a5157951",
"77ab2ef0-0d27-4aac-8dd2-a96f892bb0e1"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"5ce16acf-022a-4869-94d6-27f17b5b7f47","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["4df53d1e-3f88-4b24-9daf-58a7a5157951","77ab2ef0-0d27-4aac-8dd2-a96f892bb0e1"],"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>5ce16acf-022a-4869-94d6-27f17b5b7f47</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>4df53d1e-3f88-4b24-9daf-58a7a5157951</d2p1:guid>
<d2p1:guid>77ab2ef0-0d27-4aac-8dd2-a96f892bb0e1</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": "010f7b6d-9cb5-4b59-a55a-0c4159e8905a",
"ClubId": "75ac8c1a-9f2b-4c74-9a6a-08ae895bb59b",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "5d5be08a-d061-427a-a884-55132ebb1b52",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"ba1eb23d-4f64-4b51-ace2-31d7e9869ee9",
"68e64781-f888-42c7-ac78-624396592dbd"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-25T14:05:21.6051335+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "010f7b6d-9cb5-4b59-a55a-0c4159e8905a",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"010f7b6d-9cb5-4b59-a55a-0c4159e8905a","ClubId":"75ac8c1a-9f2b-4c74-9a6a-08ae895bb59b","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5d5be08a-d061-427a-a884-55132ebb1b52","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["ba1eb23d-4f64-4b51-ace2-31d7e9869ee9","68e64781-f888-42c7-ac78-624396592dbd"],"AccountState":7,"LastPasswordChangeOn":"2025-11-25T14:05:21.6051335+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"010f7b6d-9cb5-4b59-a55a-0c4159e8905a","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">010f7b6d-9cb5-4b59-a55a-0c4159e8905a</Id>
<AccountState>7</AccountState>
<ClubId>75ac8c1a-9f2b-4c74-9a6a-08ae895bb59b</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-25T14:05:21.6051335+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>5d5be08a-d061-427a-a884-55132ebb1b52</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>010f7b6d-9cb5-4b59-a55a-0c4159e8905a</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>ba1eb23d-4f64-4b51-ace2-31d7e9869ee9</d2p1:guid>
<d2p1:guid>68e64781-f888-42c7-ac78-624396592dbd</d2p1:guid>
</UserRoleIds>
</UserDetails>