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": "8343676c-c335-45a9-8f30-29e07acd8e10", "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": "98da6b63-86bf-4b8e-b8d0-c82e69eac32f", "Teams": [ { "TeamId": "cfeea3d9-f09d-4b51-b70d-d7b409af9b74", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3532e0db-f395-4031-9a06-3990f99268f7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "b6a24ebd-3b24-4635-81f1-96d7dfefc590", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3532e0db-f395-4031-9a06-3990f99268f7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "b6a24ebd-3b24-4635-81f1-96d7dfefc590", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7a327405-9a20-4dd9-86fa-b6dba095b826", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "cfeea3d9-f09d-4b51-b70d-d7b409af9b74", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3532e0db-f395-4031-9a06-3990f99268f7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "b6a24ebd-3b24-4635-81f1-96d7dfefc590", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3532e0db-f395-4031-9a06-3990f99268f7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "b6a24ebd-3b24-4635-81f1-96d7dfefc590", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7a327405-9a20-4dd9-86fa-b6dba095b826", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-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": "189c8a3c-9081-4e7e-9705-9d066441ce5e", "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": "73a171d2-6044-4529-aae2-9a118a250ef0", "Teams": [ { "TeamId": "dc397060-2191-4416-bf53-8728cb9ba611", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "462c1d09-9341-4a75-8315-52796373ab29", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "82610695-0ddc-4233-b1c7-81271f8217fd", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "462c1d09-9341-4a75-8315-52796373ab29", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "82610695-0ddc-4233-b1c7-81271f8217fd", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "be71581c-cddb-439a-8e08-3a0d1198f7e1", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "dc397060-2191-4416-bf53-8728cb9ba611", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "462c1d09-9341-4a75-8315-52796373ab29", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "82610695-0ddc-4233-b1c7-81271f8217fd", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "462c1d09-9341-4a75-8315-52796373ab29", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "MeasurementValueNeededDate": "2023-12-01T10:33:20.6018544-08:00", "SourceSystemId": "sample string 3", "CompanyId": "82610695-0ddc-4233-b1c7-81271f8217fd", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "be71581c-cddb-439a-8e08-3a0d1198f7e1", "CreateDate": "2023-12-01T10:33:20.6018544-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-12-01T10:33:20.6018544-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }