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": "ed2c26d8-2319-4d23-81f3-1710aeca1606", "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": "8f41275c-6fce-49f2-b1f5-8be79da9c265", "Teams": [ { "TeamId": "8773f960-cb1a-4151-9dc1-e4cb28529695", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1c24fbce-66f6-4698-ace0-4cd0a66a9b97", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a7db7227-58f5-43ec-ade1-1861b9433bee", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1c24fbce-66f6-4698-ace0-4cd0a66a9b97", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a7db7227-58f5-43ec-ade1-1861b9433bee", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "5c25b9f5-ea8e-4482-9038-3ff5b9ad0f34", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8773f960-cb1a-4151-9dc1-e4cb28529695", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1c24fbce-66f6-4698-ace0-4cd0a66a9b97", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a7db7227-58f5-43ec-ade1-1861b9433bee", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1c24fbce-66f6-4698-ace0-4cd0a66a9b97", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a7db7227-58f5-43ec-ade1-1861b9433bee", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "5c25b9f5-ea8e-4482-9038-3ff5b9ad0f34", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-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": "4ce18887-6965-4e0d-9c57-c1ae6025dffb", "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": "d291c322-8a53-42a0-9205-d5f58557f723", "Teams": [ { "TeamId": "52ea0f3c-bdba-4543-a910-696a557acfba", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "c4c70b1a-690e-4602-b22d-111253771189", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6074ca01-babe-430f-a5f3-96b847981e08", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "c4c70b1a-690e-4602-b22d-111253771189", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6074ca01-babe-430f-a5f3-96b847981e08", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "b1a4e36b-975f-453f-8a86-43484e1af1cc", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "52ea0f3c-bdba-4543-a910-696a557acfba", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "c4c70b1a-690e-4602-b22d-111253771189", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6074ca01-babe-430f-a5f3-96b847981e08", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "c4c70b1a-690e-4602-b22d-111253771189", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "MeasurementValueNeededDate": "2025-04-03T15:18:24.6970141-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6074ca01-babe-430f-a5f3-96b847981e08", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "b1a4e36b-975f-453f-8a86-43484e1af1cc", "CreateDate": "2025-04-03T15:18:24.6970141-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-03T15:18:24.6970141-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }