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": "7af13588-3b23-478d-bc20-044c4854f971", "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": "304ed223-c98b-4103-8ca8-bf52dcb7ab46", "Teams": [ { "TeamId": "7fcea211-5aa8-4122-8a10-108cf3db461b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "62e10de2-58b9-4950-9dde-48134ab5a952", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "e90be039-7f42-4ce7-b41e-b6e69d603586", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "62e10de2-58b9-4950-9dde-48134ab5a952", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "e90be039-7f42-4ce7-b41e-b6e69d603586", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "6f13bad0-adde-4faf-9f7b-34c45c43ee60", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "7fcea211-5aa8-4122-8a10-108cf3db461b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "62e10de2-58b9-4950-9dde-48134ab5a952", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "e90be039-7f42-4ce7-b41e-b6e69d603586", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "62e10de2-58b9-4950-9dde-48134ab5a952", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "e90be039-7f42-4ce7-b41e-b6e69d603586", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "6f13bad0-adde-4faf-9f7b-34c45c43ee60", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-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": "7187dd24-8f57-4b9c-bf6e-b9ec35ba115b", "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": "803801f2-abd1-4ab1-94f2-ab741dc7bfc0", "Teams": [ { "TeamId": "e21829d6-217d-426f-805d-4d21d43fdeb0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "56ae2676-1238-4bf2-b73c-01b07ad91346", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "2cf7b66f-5f27-4f31-9e32-0da256dec7be", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "56ae2676-1238-4bf2-b73c-01b07ad91346", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "2cf7b66f-5f27-4f31-9e32-0da256dec7be", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d05448c0-8913-47b7-a4f4-f8f3dae13d6d", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "e21829d6-217d-426f-805d-4d21d43fdeb0", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "56ae2676-1238-4bf2-b73c-01b07ad91346", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "2cf7b66f-5f27-4f31-9e32-0da256dec7be", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "56ae2676-1238-4bf2-b73c-01b07ad91346", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "MeasurementValueNeededDate": "2024-12-21T18:50:39.7054757-08:00", "SourceSystemId": "sample string 3", "CompanyId": "2cf7b66f-5f27-4f31-9e32-0da256dec7be", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d05448c0-8913-47b7-a4f4-f8f3dae13d6d", "CreateDate": "2024-12-21T18:50:39.7054757-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T18:50:39.7054757-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }