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": "8c1c24b6-65e5-4afe-ad0e-a8f9fd9411b9", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "6058a3ba-be9c-422e-bccd-ca1c26c74ae1", "45ad3506-fd36-440e-982f-e094a0241929" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"8c1c24b6-65e5-4afe-ad0e-a8f9fd9411b9","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["6058a3ba-be9c-422e-bccd-ca1c26c74ae1","45ad3506-fd36-440e-982f-e094a0241929"],"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>8c1c24b6-65e5-4afe-ad0e-a8f9fd9411b9</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>6058a3ba-be9c-422e-bccd-ca1c26c74ae1</d2p1:guid> <d2p1:guid>45ad3506-fd36-440e-982f-e094a0241929</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": "aa7e187d-90b0-440c-8272-e6f0c4dabc79", "ClubId": "192505e3-c3fa-461f-b89f-1fe78898e187", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "620e7a76-127a-4e3d-8a14-ea402b086ea6", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "18c411a3-29f7-4704-b642-339dcefda64d", "0523656e-02de-4a6c-98c1-6ee94a8c3b45" ], "AccountState": 7, "LastPasswordChangeOn": "2024-04-25T13:14:05.7368879+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "aa7e187d-90b0-440c-8272-e6f0c4dabc79", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"aa7e187d-90b0-440c-8272-e6f0c4dabc79","ClubId":"192505e3-c3fa-461f-b89f-1fe78898e187","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"620e7a76-127a-4e3d-8a14-ea402b086ea6","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["18c411a3-29f7-4704-b642-339dcefda64d","0523656e-02de-4a6c-98c1-6ee94a8c3b45"],"AccountState":7,"LastPasswordChangeOn":"2024-04-25T13:14:05.7368879+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"aa7e187d-90b0-440c-8272-e6f0c4dabc79","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">aa7e187d-90b0-440c-8272-e6f0c4dabc79</Id> <AccountState>7</AccountState> <ClubId>192505e3-c3fa-461f-b89f-1fe78898e187</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-04-25T13:14:05.7368879+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>620e7a76-127a-4e3d-8a14-ea402b086ea6</PersonId> <Remarks>sample string 5</Remarks> <UserId>aa7e187d-90b0-440c-8272-e6f0c4dabc79</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>18c411a3-29f7-4704-b642-339dcefda64d</d2p1:guid> <d2p1:guid>0523656e-02de-4a6c-98c1-6ee94a8c3b45</d2p1:guid> </UserRoleIds> </UserDetails>