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": "b89d2650-f67c-4517-b3f8-a2b550bd89ea", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "ebf30798-3530-4632-8f3a-3e9a6a968c4f", "088910e3-a348-4bd1-9bc1-4e2e75b4b288" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"b89d2650-f67c-4517-b3f8-a2b550bd89ea","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["ebf30798-3530-4632-8f3a-3e9a6a968c4f","088910e3-a348-4bd1-9bc1-4e2e75b4b288"],"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>b89d2650-f67c-4517-b3f8-a2b550bd89ea</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>ebf30798-3530-4632-8f3a-3e9a6a968c4f</d2p1:guid> <d2p1:guid>088910e3-a348-4bd1-9bc1-4e2e75b4b288</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": "3224a0f3-b2b3-4882-b676-ff21f82ad1d1", "ClubId": "bca091e1-bd99-4d15-88c6-e9690265d7a8", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "c921b3ba-ab1c-4702-a4bf-717802aaeea2", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "248eb508-2db4-4537-9528-e22f3995a0cd", "7d205654-ba01-47c2-bde0-b65f90139987" ], "AccountState": 7, "LastPasswordChangeOn": "2025-09-18T19:40:30.1248977+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "3224a0f3-b2b3-4882-b676-ff21f82ad1d1", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"3224a0f3-b2b3-4882-b676-ff21f82ad1d1","ClubId":"bca091e1-bd99-4d15-88c6-e9690265d7a8","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"c921b3ba-ab1c-4702-a4bf-717802aaeea2","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["248eb508-2db4-4537-9528-e22f3995a0cd","7d205654-ba01-47c2-bde0-b65f90139987"],"AccountState":7,"LastPasswordChangeOn":"2025-09-18T19:40:30.1248977+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"3224a0f3-b2b3-4882-b676-ff21f82ad1d1","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">3224a0f3-b2b3-4882-b676-ff21f82ad1d1</Id> <AccountState>7</AccountState> <ClubId>bca091e1-bd99-4d15-88c6-e9690265d7a8</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-09-18T19:40:30.1248977+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>c921b3ba-ab1c-4702-a4bf-717802aaeea2</PersonId> <Remarks>sample string 5</Remarks> <UserId>3224a0f3-b2b3-4882-b676-ff21f82ad1d1</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>248eb508-2db4-4537-9528-e22f3995a0cd</d2p1:guid> <d2p1:guid>7d205654-ba01-47c2-bde0-b65f90139987</d2p1:guid> </UserRoleIds> </UserDetails>