POST api/v1/users
Request Information
URI Parameters
None.
Body Parameters
UserRegistrationDetailsName | 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": "3deb3977-b502-49ea-83a3-1c0ab58a34e5", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "4533a828-87c5-405f-876b-64dddb7e04ae", "4ef55768-1ea6-4c12-a303-89cce0fd5fe3" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"3deb3977-b502-49ea-83a3-1c0ab58a34e5","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["4533a828-87c5-405f-876b-64dddb7e04ae","4ef55768-1ea6-4c12-a303-89cce0fd5fe3"],"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>3deb3977-b502-49ea-83a3-1c0ab58a34e5</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>4533a828-87c5-405f-876b-64dddb7e04ae</d2p1:guid> <d2p1:guid>4ef55768-1ea6-4c12-a303-89cce0fd5fe3</d2p1:guid> </UserRoleIds> </UserRegistrationDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetailsName | 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": "6547bee7-9e61-4350-80d2-563af61c0551", "ClubId": "86a1cdc2-89b3-4cfb-ad7a-0cd49e6037df", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "dc52f723-56fa-4be3-8115-353a3aeb81c9", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "091831f3-72b0-413f-8680-c22f2d598ea3", "1bb4542a-2b72-4811-861d-df8c49c2bca2" ], "AccountState": 7, "LastPasswordChangeOn": "2025-08-30T06:38:28.1385275+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "6547bee7-9e61-4350-80d2-563af61c0551", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"6547bee7-9e61-4350-80d2-563af61c0551","ClubId":"86a1cdc2-89b3-4cfb-ad7a-0cd49e6037df","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"dc52f723-56fa-4be3-8115-353a3aeb81c9","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["091831f3-72b0-413f-8680-c22f2d598ea3","1bb4542a-2b72-4811-861d-df8c49c2bca2"],"AccountState":7,"LastPasswordChangeOn":"2025-08-30T06:38:28.1385275+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"6547bee7-9e61-4350-80d2-563af61c0551","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">6547bee7-9e61-4350-80d2-563af61c0551</Id> <AccountState>7</AccountState> <ClubId>86a1cdc2-89b3-4cfb-ad7a-0cd49e6037df</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-08-30T06:38:28.1385275+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>dc52f723-56fa-4be3-8115-353a3aeb81c9</PersonId> <Remarks>sample string 5</Remarks> <UserId>6547bee7-9e61-4350-80d2-563af61c0551</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>091831f3-72b0-413f-8680-c22f2d598ea3</d2p1:guid> <d2p1:guid>1bb4542a-2b72-4811-861d-df8c49c2bca2</d2p1:guid> </UserRoleIds> </UserDetails>