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": "bb31d784-0737-4a2f-8ddb-eac33f4d2f23",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"80c2cd60-085e-4130-b1b5-635999a4db3d",
"c144460e-15e1-4c5f-8e73-256bfbec0302"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"bb31d784-0737-4a2f-8ddb-eac33f4d2f23","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["80c2cd60-085e-4130-b1b5-635999a4db3d","c144460e-15e1-4c5f-8e73-256bfbec0302"],"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>bb31d784-0737-4a2f-8ddb-eac33f4d2f23</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>80c2cd60-085e-4130-b1b5-635999a4db3d</d2p1:guid>
<d2p1:guid>c144460e-15e1-4c5f-8e73-256bfbec0302</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": "36768369-c60c-491f-897b-7e4427946e47",
"ClubId": "b67c50e8-4645-465a-87ea-685fa8cd0f28",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "416dcd07-1038-4870-b80f-5f7fa2ecfc1d",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"3684a16c-4658-4d55-97d1-75248c1bbdb9",
"a323509f-bfcc-4ca9-91f5-e4a3d04a8990"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-05-28T13:38:12.9167745+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "36768369-c60c-491f-897b-7e4427946e47",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"36768369-c60c-491f-897b-7e4427946e47","ClubId":"b67c50e8-4645-465a-87ea-685fa8cd0f28","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"416dcd07-1038-4870-b80f-5f7fa2ecfc1d","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["3684a16c-4658-4d55-97d1-75248c1bbdb9","a323509f-bfcc-4ca9-91f5-e4a3d04a8990"],"AccountState":7,"LastPasswordChangeOn":"2026-05-28T13:38:12.9167745+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"36768369-c60c-491f-897b-7e4427946e47","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">36768369-c60c-491f-897b-7e4427946e47</Id>
<AccountState>7</AccountState>
<ClubId>b67c50e8-4645-465a-87ea-685fa8cd0f28</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-05-28T13:38:12.9167745+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>416dcd07-1038-4870-b80f-5f7fa2ecfc1d</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>36768369-c60c-491f-897b-7e4427946e47</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>3684a16c-4658-4d55-97d1-75248c1bbdb9</d2p1:guid>
<d2p1:guid>a323509f-bfcc-4ca9-91f5-e4a3d04a8990</d2p1:guid>
</UserRoleIds>
</UserDetails>