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": "4491f5bd-eecf-48e0-832a-3b6325242787",
"ClubId": "159b5e39-6c3a-4041-8580-a978a2c0dedc",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "c52ba78f-5e2c-43be-9081-aba1c4d6311a",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"cae8db8b-7914-4edb-b078-b014e5a7e864",
"f1cc675a-ca7c-4f20-ae70-27be3b74dc8f"
],
"AccountState": 7,
"LastPasswordChangeOn": "2020-04-02T14:19:52.809877+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "4491f5bd-eecf-48e0-832a-3b6325242787",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"4491f5bd-eecf-48e0-832a-3b6325242787","ClubId":"159b5e39-6c3a-4041-8580-a978a2c0dedc","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"c52ba78f-5e2c-43be-9081-aba1c4d6311a","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["cae8db8b-7914-4edb-b078-b014e5a7e864","f1cc675a-ca7c-4f20-ae70-27be3b74dc8f"],"AccountState":7,"LastPasswordChangeOn":"2020-04-02T14:19:52.809877+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"4491f5bd-eecf-48e0-832a-3b6325242787","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">4491f5bd-eecf-48e0-832a-3b6325242787</Id>
<AccountState>7</AccountState>
<ClubId>159b5e39-6c3a-4041-8580-a978a2c0dedc</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2020-04-02T14:19:52.809877+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>c52ba78f-5e2c-43be-9081-aba1c4d6311a</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>4491f5bd-eecf-48e0-832a-3b6325242787</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>cae8db8b-7914-4edb-b078-b014e5a7e864</d2p1:guid>
<d2p1:guid>f1cc675a-ca7c-4f20-ae70-27be3b74dc8f</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": "611ba54e-554e-4139-bafa-639e57bc7319",
"ClubId": "2b8462e2-ff4f-4463-b519-2db72ff91846",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "718fe5e6-064d-4f99-9102-eba3d13d6335",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"b00b9a01-fb6d-4a57-b1dd-052c3d9043c4",
"9d0d4e35-4dac-4208-9512-942c2f19eedb"
],
"AccountState": 7,
"LastPasswordChangeOn": "2020-04-02T14:19:52.809877+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "611ba54e-554e-4139-bafa-639e57bc7319",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"611ba54e-554e-4139-bafa-639e57bc7319","ClubId":"2b8462e2-ff4f-4463-b519-2db72ff91846","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"718fe5e6-064d-4f99-9102-eba3d13d6335","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["b00b9a01-fb6d-4a57-b1dd-052c3d9043c4","9d0d4e35-4dac-4208-9512-942c2f19eedb"],"AccountState":7,"LastPasswordChangeOn":"2020-04-02T14:19:52.809877+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"611ba54e-554e-4139-bafa-639e57bc7319","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">611ba54e-554e-4139-bafa-639e57bc7319</Id>
<AccountState>7</AccountState>
<ClubId>2b8462e2-ff4f-4463-b519-2db72ff91846</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2020-04-02T14:19:52.809877+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>718fe5e6-064d-4f99-9102-eba3d13d6335</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>611ba54e-554e-4139-bafa-639e57bc7319</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>b00b9a01-fb6d-4a57-b1dd-052c3d9043c4</d2p1:guid>
<d2p1:guid>9d0d4e35-4dac-4208-9512-942c2f19eedb</d2p1:guid>
</UserRoleIds>
</UserDetails>