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": "4e8e6859-f110-4f0a-bdeb-a16ed9a03d8e", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "85fdfb09-23d4-41b0-8058-406f4679abf4", "a508bc19-5ae2-42b7-b81c-83c052e56f23" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"4e8e6859-f110-4f0a-bdeb-a16ed9a03d8e","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["85fdfb09-23d4-41b0-8058-406f4679abf4","a508bc19-5ae2-42b7-b81c-83c052e56f23"],"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>4e8e6859-f110-4f0a-bdeb-a16ed9a03d8e</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>85fdfb09-23d4-41b0-8058-406f4679abf4</d2p1:guid> <d2p1:guid>a508bc19-5ae2-42b7-b81c-83c052e56f23</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": "597355b2-2cf1-4540-9dc6-e788610c0007", "ClubId": "de261f36-f870-424a-8b03-3e2a1fbef87d", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "3f5e72f5-94b5-473d-999c-2fec6b3a76ee", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "9b9d7bf3-5e49-43a9-a838-887eb57b480f", "ca54d90b-191c-4006-ae2c-6dc837419c7e" ], "AccountState": 7, "LastPasswordChangeOn": "2025-06-21T21:46:19.2649649+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "597355b2-2cf1-4540-9dc6-e788610c0007", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"597355b2-2cf1-4540-9dc6-e788610c0007","ClubId":"de261f36-f870-424a-8b03-3e2a1fbef87d","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"3f5e72f5-94b5-473d-999c-2fec6b3a76ee","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["9b9d7bf3-5e49-43a9-a838-887eb57b480f","ca54d90b-191c-4006-ae2c-6dc837419c7e"],"AccountState":7,"LastPasswordChangeOn":"2025-06-21T21:46:19.2649649+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"597355b2-2cf1-4540-9dc6-e788610c0007","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">597355b2-2cf1-4540-9dc6-e788610c0007</Id> <AccountState>7</AccountState> <ClubId>de261f36-f870-424a-8b03-3e2a1fbef87d</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-06-21T21:46:19.2649649+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>3f5e72f5-94b5-473d-999c-2fec6b3a76ee</PersonId> <Remarks>sample string 5</Remarks> <UserId>597355b2-2cf1-4540-9dc6-e788610c0007</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>9b9d7bf3-5e49-43a9-a838-887eb57b480f</d2p1:guid> <d2p1:guid>ca54d90b-191c-4006-ae2c-6dc837419c7e</d2p1:guid> </UserRoleIds> </UserDetails>