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": "8bee29bc-af12-472b-9983-a626d11d5107",
"Remarks": "sample string 3",
"UserName": "sample string 4",
"UserRoleIds": [
"1a853dda-a158-411d-9db3-cfc37dcd12aa",
"2dc66edb-80b9-4766-b295-55caab442904"
],
"EmailConfirmationLink": "sample string 5"
}
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"8bee29bc-af12-472b-9983-a626d11d5107","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["1a853dda-a158-411d-9db3-cfc37dcd12aa","2dc66edb-80b9-4766-b295-55caab442904"],"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>8bee29bc-af12-472b-9983-a626d11d5107</PersonId>
<Remarks>sample string 3</Remarks>
<UserName>sample string 4</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>1a853dda-a158-411d-9db3-cfc37dcd12aa</d2p1:guid>
<d2p1:guid>2dc66edb-80b9-4766-b295-55caab442904</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": "c6b77578-d77a-4c41-9419-dcd63c3a59c1",
"ClubId": "85e6ea3d-849e-42be-9d5d-1ff35584b55a",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "d5a8b0fe-5fed-44e3-8743-b2d17f91b8a1",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"1621954c-ce0f-454c-a92d-54af7f7a7c2b",
"cbb6ae2d-28c2-4962-9fb5-b1d872984f1e"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-22T05:20:29.1690674+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c6b77578-d77a-4c41-9419-dcd63c3a59c1",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c6b77578-d77a-4c41-9419-dcd63c3a59c1","ClubId":"85e6ea3d-849e-42be-9d5d-1ff35584b55a","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"d5a8b0fe-5fed-44e3-8743-b2d17f91b8a1","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["1621954c-ce0f-454c-a92d-54af7f7a7c2b","cbb6ae2d-28c2-4962-9fb5-b1d872984f1e"],"AccountState":7,"LastPasswordChangeOn":"2025-11-22T05:20:29.1690674+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c6b77578-d77a-4c41-9419-dcd63c3a59c1","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">c6b77578-d77a-4c41-9419-dcd63c3a59c1</Id>
<AccountState>7</AccountState>
<ClubId>85e6ea3d-849e-42be-9d5d-1ff35584b55a</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-22T05:20:29.1690674+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>d5a8b0fe-5fed-44e3-8743-b2d17f91b8a1</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c6b77578-d77a-4c41-9419-dcd63c3a59c1</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>1621954c-ce0f-454c-a92d-54af7f7a7c2b</d2p1:guid>
<d2p1:guid>cbb6ae2d-28c2-4962-9fb5-b1d872984f1e</d2p1:guid>
</UserRoleIds>
</UserDetails>