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": "f698c43c-f56c-4555-aeec-40e93cbebde4", "ClubId": "48efaf36-968c-450d-833d-ed5fc2ea8430", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "d770ee18-7e01-46c3-ab54-688e58c32975", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "ff77be82-f74c-4b37-9351-cb8eff253911", "143ee258-425a-4b97-b0b7-0bab10d686c2" ], "AccountState": 7, "LastPasswordChangeOn": "2023-01-31T04:45:56.3664263+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "f698c43c-f56c-4555-aeec-40e93cbebde4", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"f698c43c-f56c-4555-aeec-40e93cbebde4","ClubId":"48efaf36-968c-450d-833d-ed5fc2ea8430","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"d770ee18-7e01-46c3-ab54-688e58c32975","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["ff77be82-f74c-4b37-9351-cb8eff253911","143ee258-425a-4b97-b0b7-0bab10d686c2"],"AccountState":7,"LastPasswordChangeOn":"2023-01-31T04:45:56.3664263+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"f698c43c-f56c-4555-aeec-40e93cbebde4","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">f698c43c-f56c-4555-aeec-40e93cbebde4</Id> <AccountState>7</AccountState> <ClubId>48efaf36-968c-450d-833d-ed5fc2ea8430</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2023-01-31T04:45:56.3664263+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>d770ee18-7e01-46c3-ab54-688e58c32975</PersonId> <Remarks>sample string 5</Remarks> <UserId>f698c43c-f56c-4555-aeec-40e93cbebde4</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>ff77be82-f74c-4b37-9351-cb8eff253911</d2p1:guid> <d2p1:guid>143ee258-425a-4b97-b0b7-0bab10d686c2</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": "46b4fda9-5e66-4785-8b76-ecb3ba66bfa0", "ClubId": "9941c458-7d64-4248-bc8c-481eb0035004", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "ce21b7c8-062e-44aa-a1f4-9ff86455a048", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "e60f8501-24c4-4ad0-abc1-ac7cb9a76e62", "abbbd877-287c-471a-bd66-f834ce3e75c0" ], "AccountState": 7, "LastPasswordChangeOn": "2023-01-31T04:45:56.3664263+01:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "46b4fda9-5e66-4785-8b76-ecb3ba66bfa0", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"46b4fda9-5e66-4785-8b76-ecb3ba66bfa0","ClubId":"9941c458-7d64-4248-bc8c-481eb0035004","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"ce21b7c8-062e-44aa-a1f4-9ff86455a048","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["e60f8501-24c4-4ad0-abc1-ac7cb9a76e62","abbbd877-287c-471a-bd66-f834ce3e75c0"],"AccountState":7,"LastPasswordChangeOn":"2023-01-31T04:45:56.3664263+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"46b4fda9-5e66-4785-8b76-ecb3ba66bfa0","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">46b4fda9-5e66-4785-8b76-ecb3ba66bfa0</Id> <AccountState>7</AccountState> <ClubId>9941c458-7d64-4248-bc8c-481eb0035004</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2023-01-31T04:45:56.3664263+01:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>ce21b7c8-062e-44aa-a1f4-9ff86455a048</PersonId> <Remarks>sample string 5</Remarks> <UserId>46b4fda9-5e66-4785-8b76-ecb3ba66bfa0</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>e60f8501-24c4-4ad0-abc1-ac7cb9a76e62</d2p1:guid> <d2p1:guid>abbbd877-287c-471a-bd66-f834ce3e75c0</d2p1:guid> </UserRoleIds> </UserDetails>