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": "19018cff-10ec-43cb-a8e7-3d8e3706089e", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "2f18cc07-d2c4-4536-8550-0ab66dee4869", "643ed66b-bb37-4868-819d-2d29f4eb0f13" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"19018cff-10ec-43cb-a8e7-3d8e3706089e","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["2f18cc07-d2c4-4536-8550-0ab66dee4869","643ed66b-bb37-4868-819d-2d29f4eb0f13"],"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>19018cff-10ec-43cb-a8e7-3d8e3706089e</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>2f18cc07-d2c4-4536-8550-0ab66dee4869</d2p1:guid> <d2p1:guid>643ed66b-bb37-4868-819d-2d29f4eb0f13</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": "7b274c4b-9b8c-452f-82a2-564290d12103", "ClubId": "a862964b-6104-43b6-b49b-5c86d5d6fcf6", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "7bd482b6-5ead-48d3-9786-442b6ef80781", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "381281bf-5e9b-4242-8ca9-2c9c1c6a3679", "13bd16be-f5e0-4159-aa68-a7f1b66a0fd9" ], "AccountState": 7, "LastPasswordChangeOn": "2025-05-30T03:56:20.371601+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "7b274c4b-9b8c-452f-82a2-564290d12103", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"7b274c4b-9b8c-452f-82a2-564290d12103","ClubId":"a862964b-6104-43b6-b49b-5c86d5d6fcf6","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"7bd482b6-5ead-48d3-9786-442b6ef80781","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["381281bf-5e9b-4242-8ca9-2c9c1c6a3679","13bd16be-f5e0-4159-aa68-a7f1b66a0fd9"],"AccountState":7,"LastPasswordChangeOn":"2025-05-30T03:56:20.371601+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"7b274c4b-9b8c-452f-82a2-564290d12103","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">7b274c4b-9b8c-452f-82a2-564290d12103</Id> <AccountState>7</AccountState> <ClubId>a862964b-6104-43b6-b49b-5c86d5d6fcf6</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-05-30T03:56:20.371601+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>7bd482b6-5ead-48d3-9786-442b6ef80781</PersonId> <Remarks>sample string 5</Remarks> <UserId>7b274c4b-9b8c-452f-82a2-564290d12103</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>381281bf-5e9b-4242-8ca9-2c9c1c6a3679</d2p1:guid> <d2p1:guid>13bd16be-f5e0-4159-aa68-a7f1b66a0fd9</d2p1:guid> </UserRoleIds> </UserDetails>