PUT api/v1/users/{userId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId | globally unique identifier |
Required |
Body Parameters
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. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "b89c797b-2f2d-4bb2-9b1b-62d890ca9392", "ClubId": "cd87344d-6d15-403a-8ac9-28ffb8786de4", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "69940828-6494-4f76-8d05-d5e9ab44d3a9", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "aee99569-d8a3-4f16-8a13-356e5df04293", "a5c9be56-cdb1-4272-8ff9-9436d791295b" ], "AccountState": 7, "LastPasswordChangeOn": "2024-04-26T06:55:15.9868878+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "b89c797b-2f2d-4bb2-9b1b-62d890ca9392", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"b89c797b-2f2d-4bb2-9b1b-62d890ca9392","ClubId":"cd87344d-6d15-403a-8ac9-28ffb8786de4","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"69940828-6494-4f76-8d05-d5e9ab44d3a9","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["aee99569-d8a3-4f16-8a13-356e5df04293","a5c9be56-cdb1-4272-8ff9-9436d791295b"],"AccountState":7,"LastPasswordChangeOn":"2024-04-26T06:55:15.9868878+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"b89c797b-2f2d-4bb2-9b1b-62d890ca9392","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">b89c797b-2f2d-4bb2-9b1b-62d890ca9392</Id> <AccountState>7</AccountState> <ClubId>cd87344d-6d15-403a-8ac9-28ffb8786de4</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-04-26T06:55:15.9868878+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>69940828-6494-4f76-8d05-d5e9ab44d3a9</PersonId> <Remarks>sample string 5</Remarks> <UserId>b89c797b-2f2d-4bb2-9b1b-62d890ca9392</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>aee99569-d8a3-4f16-8a13-356e5df04293</d2p1:guid> <d2p1:guid>a5c9be56-cdb1-4272-8ff9-9436d791295b</d2p1:guid> </UserRoleIds> </UserDetails>
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": "263d0888-df89-45da-a8b7-e187cf8593d7", "ClubId": "ade28065-bcf5-491e-b600-2ff95e2fe7ee", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "81fb0bbc-20ed-4fa0-9855-7098a483004a", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "353f42cd-8e7b-4408-9583-a1f6edd4298e", "4f1ac954-c7b3-4785-a0d7-f00dea3879c5" ], "AccountState": 7, "LastPasswordChangeOn": "2024-04-26T06:55:15.9868878+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "263d0888-df89-45da-a8b7-e187cf8593d7", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"263d0888-df89-45da-a8b7-e187cf8593d7","ClubId":"ade28065-bcf5-491e-b600-2ff95e2fe7ee","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"81fb0bbc-20ed-4fa0-9855-7098a483004a","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["353f42cd-8e7b-4408-9583-a1f6edd4298e","4f1ac954-c7b3-4785-a0d7-f00dea3879c5"],"AccountState":7,"LastPasswordChangeOn":"2024-04-26T06:55:15.9868878+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"263d0888-df89-45da-a8b7-e187cf8593d7","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">263d0888-df89-45da-a8b7-e187cf8593d7</Id> <AccountState>7</AccountState> <ClubId>ade28065-bcf5-491e-b600-2ff95e2fe7ee</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2024-04-26T06:55:15.9868878+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>81fb0bbc-20ed-4fa0-9855-7098a483004a</PersonId> <Remarks>sample string 5</Remarks> <UserId>263d0888-df89-45da-a8b7-e187cf8593d7</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>353f42cd-8e7b-4408-9583-a1f6edd4298e</d2p1:guid> <d2p1:guid>4f1ac954-c7b3-4785-a0d7-f00dea3879c5</d2p1:guid> </UserRoleIds> </UserDetails>