POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
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": "20f156ed-c7fa-4512-8704-1f60fd5f701c", "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": "c33584ae-905b-421c-bcff-7a283b950484", "Teams": [ { "TeamId": "f5b95f82-4e7f-4451-a75b-3e6edcaa38a6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ae1376f3-a2c5-4da2-9837-61ed5514c6f4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7c1c6558-2693-47ac-9aee-af97a4d6b443", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ae1376f3-a2c5-4da2-9837-61ed5514c6f4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7c1c6558-2693-47ac-9aee-af97a4d6b443", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0242c1a0-ee15-46bb-8d43-44aaed4304b8", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "f5b95f82-4e7f-4451-a75b-3e6edcaa38a6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ae1376f3-a2c5-4da2-9837-61ed5514c6f4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7c1c6558-2693-47ac-9aee-af97a4d6b443", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ae1376f3-a2c5-4da2-9837-61ed5514c6f4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7c1c6558-2693-47ac-9aee-af97a4d6b443", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0242c1a0-ee15-46bb-8d43-44aaed4304b8", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ] }
Response Information
Resource Description
On success, the created user.
Name | Description | Type | Additional information |
---|---|---|---|
Data | User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "UserId": "39606180-6487-419c-99ad-691609edff07", "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": "6e115097-04ed-4b7d-8c7e-f680c23723d5", "Teams": [ { "TeamId": "025c9a7d-5b26-4c15-894f-2c34b784b3cf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a3fc67bd-41f9-41b6-8cbf-daa0053beb4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "12890436-ff2b-4b68-ac72-fbc169ca72ed", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a3fc67bd-41f9-41b6-8cbf-daa0053beb4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "12890436-ff2b-4b68-ac72-fbc169ca72ed", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "cf5a62ad-f0aa-4f65-bc6e-99f519fec0d5", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "025c9a7d-5b26-4c15-894f-2c34b784b3cf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "a3fc67bd-41f9-41b6-8cbf-daa0053beb4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "12890436-ff2b-4b68-ac72-fbc169ca72ed", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "a3fc67bd-41f9-41b6-8cbf-daa0053beb4b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "MeasurementValueNeededDate": "2025-06-22T22:30:21.1995503-07:00", "SourceSystemId": "sample string 3", "CompanyId": "12890436-ff2b-4b68-ac72-fbc169ca72ed", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "cf5a62ad-f0aa-4f65-bc6e-99f519fec0d5", "CreateDate": "2025-06-22T22:30:21.1995503-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T22:30:21.1995503-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }