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": "bea913c7-f671-465e-9c14-780e79ffad10", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "f3a537bf-b39c-468a-a6db-cc133252b054", "df50ee33-abae-444a-806f-85d061051ee9" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"bea913c7-f671-465e-9c14-780e79ffad10","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["f3a537bf-b39c-468a-a6db-cc133252b054","df50ee33-abae-444a-806f-85d061051ee9"],"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>bea913c7-f671-465e-9c14-780e79ffad10</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>f3a537bf-b39c-468a-a6db-cc133252b054</d2p1:guid> <d2p1:guid>df50ee33-abae-444a-806f-85d061051ee9</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": "4eca8225-8a32-4e91-b955-1359eac5fccf", "ClubId": "fed74ac6-c58a-4a7f-bcea-258ac710f333", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "965bf58f-c76b-4aeb-aeec-b42bad5ad06e", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "1fdbd3f2-beb2-4070-bd87-789cae15371e", "c137e4d5-8084-46a9-b60e-7d998d48c677" ], "AccountState": 7, "LastPasswordChangeOn": "2024-10-29T15:42:40.3394641+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "4eca8225-8a32-4e91-b955-1359eac5fccf", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"4eca8225-8a32-4e91-b955-1359eac5fccf","ClubId":"fed74ac6-c58a-4a7f-bcea-258ac710f333","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"965bf58f-c76b-4aeb-aeec-b42bad5ad06e","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["1fdbd3f2-beb2-4070-bd87-789cae15371e","c137e4d5-8084-46a9-b60e-7d998d48c677"],"AccountState":7,"LastPasswordChangeOn":"2024-10-29T15:42:40.3394641+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"4eca8225-8a32-4e91-b955-1359eac5fccf","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">4eca8225-8a32-4e91-b955-1359eac5fccf</Id> <AccountState>7</AccountState> <ClubId>fed74ac6-c58a-4a7f-bcea-258ac710f333</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-10-29T15:42:40.3394641+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>965bf58f-c76b-4aeb-aeec-b42bad5ad06e</PersonId> <Remarks>sample string 5</Remarks> <UserId>4eca8225-8a32-4e91-b955-1359eac5fccf</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>1fdbd3f2-beb2-4070-bd87-789cae15371e</d2p1:guid> <d2p1:guid>c137e4d5-8084-46a9-b60e-7d998d48c677</d2p1:guid> </UserRoleIds> </UserDetails>