PUT Users
Updates the given user.
Request Information
URI Parameters
None.
Body Parameters
User to be updated
UserName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
UserName | string |
None. |
|
FullName | string |
None. |
|
PhoneNumber | string |
None. |
|
string |
None. |
||
IsLockedOut | boolean |
None. |
|
IsApproved | boolean |
None. |
|
Role | Role |
None. |
|
CompanyId | globally unique identifier |
None. |
|
Teams | Collection of Team |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "810ad588-7b0b-4a08-bfb6-9ad13ca4cac7", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "9d68db70-b373-4f1b-8ba3-8cd0b6805290", "Teams": [ { "TeamId": "67a6945a-fd90-4e2f-9b33-75c28e578749", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e0f75eb5-96e2-4172-8952-68e981c04809", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "06373c0f-3af9-47db-878c-24fe87846b53", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e0f75eb5-96e2-4172-8952-68e981c04809", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "06373c0f-3af9-47db-878c-24fe87846b53", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1fdcd34d-ee3e-407a-8a9d-2d833e5f4389", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "67a6945a-fd90-4e2f-9b33-75c28e578749", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e0f75eb5-96e2-4172-8952-68e981c04809", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "06373c0f-3af9-47db-878c-24fe87846b53", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e0f75eb5-96e2-4172-8952-68e981c04809", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "06373c0f-3af9-47db-878c-24fe87846b53", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1fdcd34d-ee3e-407a-8a9d-2d833e5f4389", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ] }
Response Information
Resource Description
On success, the updated user.
Name | Description | Type | Additional information |
---|---|---|---|
Data | User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "UserId": "ea583bcd-a390-4d54-ac96-43a695229d1a", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "8a2013b7-dce6-49da-90db-9072bdf40376", "Teams": [ { "TeamId": "8ec27e36-8247-4d17-ae3f-db57dd4cc2bd", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "21874e58-0512-4dcc-8088-309d27a348ad", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1e676851-eb8d-467d-ae22-5aef53d4937d", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "21874e58-0512-4dcc-8088-309d27a348ad", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1e676851-eb8d-467d-ae22-5aef53d4937d", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "73f0fc2d-4340-4aaa-b89c-f8f045b9c9df", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8ec27e36-8247-4d17-ae3f-db57dd4cc2bd", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "21874e58-0512-4dcc-8088-309d27a348ad", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1e676851-eb8d-467d-ae22-5aef53d4937d", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "21874e58-0512-4dcc-8088-309d27a348ad", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "MeasurementValueNeededDate": "2024-12-09T03:09:12.3131774-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1e676851-eb8d-467d-ae22-5aef53d4937d", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "73f0fc2d-4340-4aaa-b89c-f8f045b9c9df", "CreateDate": "2024-12-09T03:09:12.3131774-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T03:09:12.3131774-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }