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": "9dc358ee-f2a6-4ae8-bc7c-b38e638c19e4", "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": "c819a80a-d5fa-4f69-b7ec-3f4e6196e8ac", "Teams": [ { "TeamId": "84cc4275-0afd-4068-baf0-069ec5611ae0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a5319635-b77b-48a2-bb39-4d0c29d3457d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0e710c7c-8e8d-4714-8984-226252d864c8", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a5319635-b77b-48a2-bb39-4d0c29d3457d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0e710c7c-8e8d-4714-8984-226252d864c8", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4819792a-b33e-4367-9926-d4636feb757c", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "84cc4275-0afd-4068-baf0-069ec5611ae0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a5319635-b77b-48a2-bb39-4d0c29d3457d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0e710c7c-8e8d-4714-8984-226252d864c8", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a5319635-b77b-48a2-bb39-4d0c29d3457d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0e710c7c-8e8d-4714-8984-226252d864c8", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "4819792a-b33e-4367-9926-d4636feb757c", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07: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": "bc3a46fe-0f2c-4367-8000-c2643cab3589", "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": "d6be202e-50f4-4030-a816-912e14773e50", "Teams": [ { "TeamId": "42fe1c0d-1ca1-4d7e-ac70-7671b273aa4e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ac1a32b6-956d-4b4f-8cf8-c38103d8d324", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dd7fab7e-6ce3-4352-8d11-b36da9fd228f", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ac1a32b6-956d-4b4f-8cf8-c38103d8d324", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dd7fab7e-6ce3-4352-8d11-b36da9fd228f", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3609aff7-cbf1-42cb-b9bb-fcfd1027b850", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "42fe1c0d-1ca1-4d7e-ac70-7671b273aa4e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ac1a32b6-956d-4b4f-8cf8-c38103d8d324", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dd7fab7e-6ce3-4352-8d11-b36da9fd228f", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ac1a32b6-956d-4b4f-8cf8-c38103d8d324", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "MeasurementValueNeededDate": "2024-04-28T19:35:46.130223-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dd7fab7e-6ce3-4352-8d11-b36da9fd228f", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3609aff7-cbf1-42cb-b9bb-fcfd1027b850", "CreateDate": "2024-04-28T19:35:46.130223-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T19:35:46.130223-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }