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": "7d4ddcde-9d81-4c1e-ae7a-799ba7094d28", "Remarks": "sample string 3", "UserName": "sample string 4", "UserRoleIds": [ "b74a1c65-da62-438b-b8dd-3057613c99aa", "6d4c1e35-ffa9-4210-ab28-b5a98c28340c" ], "EmailConfirmationLink": "sample string 5" }
text/html
Sample:
{"FriendlyName":"sample string 1","NotificationEmail":"sample string 2","PersonId":"7d4ddcde-9d81-4c1e-ae7a-799ba7094d28","Remarks":"sample string 3","UserName":"sample string 4","UserRoleIds":["b74a1c65-da62-438b-b8dd-3057613c99aa","6d4c1e35-ffa9-4210-ab28-b5a98c28340c"],"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>7d4ddcde-9d81-4c1e-ae7a-799ba7094d28</PersonId> <Remarks>sample string 3</Remarks> <UserName>sample string 4</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>b74a1c65-da62-438b-b8dd-3057613c99aa</d2p1:guid> <d2p1:guid>6d4c1e35-ffa9-4210-ab28-b5a98c28340c</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": "0514931d-9502-4620-8288-b2b188fdcec0", "ClubId": "1e051c2b-30cc-4ec8-bad9-9ec007478bf1", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "b76464ea-cacd-41f3-9ceb-bf73924abe49", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "b24449da-862f-4ce0-a918-84337c06bf32", "527f1e01-6e0f-43b8-b71a-294a3ebeaf50" ], "AccountState": 7, "LastPasswordChangeOn": "2024-05-16T13:53:06.3180092+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "0514931d-9502-4620-8288-b2b188fdcec0", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"0514931d-9502-4620-8288-b2b188fdcec0","ClubId":"1e051c2b-30cc-4ec8-bad9-9ec007478bf1","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"b76464ea-cacd-41f3-9ceb-bf73924abe49","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["b24449da-862f-4ce0-a918-84337c06bf32","527f1e01-6e0f-43b8-b71a-294a3ebeaf50"],"AccountState":7,"LastPasswordChangeOn":"2024-05-16T13:53:06.3180092+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"0514931d-9502-4620-8288-b2b188fdcec0","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">0514931d-9502-4620-8288-b2b188fdcec0</Id> <AccountState>7</AccountState> <ClubId>1e051c2b-30cc-4ec8-bad9-9ec007478bf1</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-05-16T13:53:06.3180092+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>b76464ea-cacd-41f3-9ceb-bf73924abe49</PersonId> <Remarks>sample string 5</Remarks> <UserId>0514931d-9502-4620-8288-b2b188fdcec0</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>b24449da-862f-4ce0-a918-84337c06bf32</d2p1:guid> <d2p1:guid>527f1e01-6e0f-43b8-b71a-294a3ebeaf50</d2p1:guid> </UserRoleIds> </UserDetails>