PUT api/v1/users/{userId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | globally unique identifier |
Required |
Body Parameters
UserDetails| Name | 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. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "9a016138-2619-48bd-aad0-399c92e4eced",
"ClubId": "778e9003-3b55-4443-aef2-03e65e92a022",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "5dec8ab9-5a6b-488e-81e0-4599ce1f053b",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"512caa02-97a0-4aae-b99c-e03cac6e30e7",
"169d0cc3-1e2a-409b-aa4b-2cff695887fa"
],
"AccountState": 7,
"LastPasswordChangeOn": "2019-10-24T03:58:15.4552717+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "9a016138-2619-48bd-aad0-399c92e4eced",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"9a016138-2619-48bd-aad0-399c92e4eced","ClubId":"778e9003-3b55-4443-aef2-03e65e92a022","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5dec8ab9-5a6b-488e-81e0-4599ce1f053b","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["512caa02-97a0-4aae-b99c-e03cac6e30e7","169d0cc3-1e2a-409b-aa4b-2cff695887fa"],"AccountState":7,"LastPasswordChangeOn":"2019-10-24T03:58:15.4552717+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"9a016138-2619-48bd-aad0-399c92e4eced","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">9a016138-2619-48bd-aad0-399c92e4eced</Id>
<AccountState>7</AccountState>
<ClubId>778e9003-3b55-4443-aef2-03e65e92a022</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2019-10-24T03:58:15.4552717+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>5dec8ab9-5a6b-488e-81e0-4599ce1f053b</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>9a016138-2619-48bd-aad0-399c92e4eced</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>512caa02-97a0-4aae-b99c-e03cac6e30e7</d2p1:guid>
<d2p1:guid>169d0cc3-1e2a-409b-aa4b-2cff695887fa</d2p1:guid>
</UserRoleIds>
</UserDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetails| Name | 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": "c012238b-ab11-446f-afbc-e63990b432b8",
"ClubId": "68a5dcfb-a52c-42f7-8e0f-9c4d6e54e736",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "cda654eb-3eb2-460a-805c-a8d854d2dc97",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"395f1876-a6cd-4861-9864-c6dade3c691a",
"aff004a3-aaf9-410c-9327-b07e2bde53df"
],
"AccountState": 7,
"LastPasswordChangeOn": "2019-10-24T03:58:15.4552717+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c012238b-ab11-446f-afbc-e63990b432b8",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c012238b-ab11-446f-afbc-e63990b432b8","ClubId":"68a5dcfb-a52c-42f7-8e0f-9c4d6e54e736","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"cda654eb-3eb2-460a-805c-a8d854d2dc97","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["395f1876-a6cd-4861-9864-c6dade3c691a","aff004a3-aaf9-410c-9327-b07e2bde53df"],"AccountState":7,"LastPasswordChangeOn":"2019-10-24T03:58:15.4552717+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c012238b-ab11-446f-afbc-e63990b432b8","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">c012238b-ab11-446f-afbc-e63990b432b8</Id>
<AccountState>7</AccountState>
<ClubId>68a5dcfb-a52c-42f7-8e0f-9c4d6e54e736</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2019-10-24T03:58:15.4552717+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>cda654eb-3eb2-460a-805c-a8d854d2dc97</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c012238b-ab11-446f-afbc-e63990b432b8</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>395f1876-a6cd-4861-9864-c6dade3c691a</d2p1:guid>
<d2p1:guid>aff004a3-aaf9-410c-9327-b07e2bde53df</d2p1:guid>
</UserRoleIds>
</UserDetails>