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": "c68b564e-2de7-4f1f-aeff-e0fc107798f7", "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": "fedb7069-af1f-4a3d-8df3-1af9b008b659", "Teams": [ { "TeamId": "31aebbd6-26bf-4efe-822a-84fdba0233b6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "329ca2e3-0f4f-4295-b9be-6b45e0f05270", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b75611de-00d9-4a39-a72c-73736a90f04c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "329ca2e3-0f4f-4295-b9be-6b45e0f05270", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b75611de-00d9-4a39-a72c-73736a90f04c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "000e4c7c-6d84-4685-b553-6d82b85637fe", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "31aebbd6-26bf-4efe-822a-84fdba0233b6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "329ca2e3-0f4f-4295-b9be-6b45e0f05270", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b75611de-00d9-4a39-a72c-73736a90f04c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "329ca2e3-0f4f-4295-b9be-6b45e0f05270", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b75611de-00d9-4a39-a72c-73736a90f04c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "000e4c7c-6d84-4685-b553-6d82b85637fe", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-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": "5c1bb2fb-10c4-48a0-963e-5b74bb562284", "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": "66179fab-cbca-42ab-883b-b2e7076e3c66", "Teams": [ { "TeamId": "fc819895-44e0-4978-8777-2cd4c8051435", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "de763ca9-316e-4a6b-b6b6-430724d0b848", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b190a10-f234-4f72-b91c-bb7730848343", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "de763ca9-316e-4a6b-b6b6-430724d0b848", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b190a10-f234-4f72-b91c-bb7730848343", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "badd1409-2244-4cbf-b3f0-38c1dd6df33c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "fc819895-44e0-4978-8777-2cd4c8051435", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "de763ca9-316e-4a6b-b6b6-430724d0b848", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b190a10-f234-4f72-b91c-bb7730848343", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "de763ca9-316e-4a6b-b6b6-430724d0b848", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "MeasurementValueNeededDate": "2024-04-24T15:06:42.1783003-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b190a10-f234-4f72-b91c-bb7730848343", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "badd1409-2244-4cbf-b3f0-38c1dd6df33c", "CreateDate": "2024-04-24T15:06:42.1783003-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T15:06:42.1783003-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }