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": "7141bd22-b391-48d1-9e1e-baa8aad9e5f3", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "18934337-c766-429e-b8b6-5d0f5cc68aa8", "57e0bd8f-2d9e-4aff-832b-ef25ce62fb27" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"7141bd22-b391-48d1-9e1e-baa8aad9e5f3","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["18934337-c766-429e-b8b6-5d0f5cc68aa8","57e0bd8f-2d9e-4aff-832b-ef25ce62fb27"],"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>7141bd22-b391-48d1-9e1e-baa8aad9e5f3</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>18934337-c766-429e-b8b6-5d0f5cc68aa8</d2p1:guid> <d2p1:guid>57e0bd8f-2d9e-4aff-832b-ef25ce62fb27</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": "15716a70-cb88-4efd-b10f-9ffaca33d5c0", "ClubId": "d9d7cd31-bdd0-4238-96d1-dc49bb0053fa", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "667d3a62-ba33-48ce-9735-f5183bea45b0", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "7ded7bab-ae70-414f-861f-de67314c6a81", "86089cd6-70c9-4730-bb3d-4cfcc318e859" ], "AccountState": 7, "LastPasswordChangeOn": "2025-07-02T04:49:24.4009511+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "15716a70-cb88-4efd-b10f-9ffaca33d5c0", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"15716a70-cb88-4efd-b10f-9ffaca33d5c0","ClubId":"d9d7cd31-bdd0-4238-96d1-dc49bb0053fa","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"667d3a62-ba33-48ce-9735-f5183bea45b0","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["7ded7bab-ae70-414f-861f-de67314c6a81","86089cd6-70c9-4730-bb3d-4cfcc318e859"],"AccountState":7,"LastPasswordChangeOn":"2025-07-02T04:49:24.4009511+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"15716a70-cb88-4efd-b10f-9ffaca33d5c0","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">15716a70-cb88-4efd-b10f-9ffaca33d5c0</Id> <AccountState>7</AccountState> <ClubId>d9d7cd31-bdd0-4238-96d1-dc49bb0053fa</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-07-02T04:49:24.4009511+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>667d3a62-ba33-48ce-9735-f5183bea45b0</PersonId> <Remarks>sample string 5</Remarks> <UserId>15716a70-cb88-4efd-b10f-9ffaca33d5c0</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>7ded7bab-ae70-414f-861f-de67314c6a81</d2p1:guid> <d2p1:guid>86089cd6-70c9-4730-bb3d-4cfcc318e859</d2p1:guid> </UserRoleIds> </UserDetails>