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": "52fd7c60-d868-4989-a4ab-71457da13215", "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": "d52e8d30-ff03-4e7d-81d5-9f0b78ea4494", "Teams": [ { "TeamId": "e8eec89f-7d47-47e1-a696-e675a912fbcb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8e848c0f-f66e-4fc8-8a66-eee7c248070b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85ea8634-a5bc-49a9-a298-6394e776198e", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8e848c0f-f66e-4fc8-8a66-eee7c248070b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85ea8634-a5bc-49a9-a298-6394e776198e", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "11fb32ec-d6c5-4eb8-95b8-d732e075d8cd", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "e8eec89f-7d47-47e1-a696-e675a912fbcb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8e848c0f-f66e-4fc8-8a66-eee7c248070b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85ea8634-a5bc-49a9-a298-6394e776198e", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8e848c0f-f66e-4fc8-8a66-eee7c248070b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85ea8634-a5bc-49a9-a298-6394e776198e", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "11fb32ec-d6c5-4eb8-95b8-d732e075d8cd", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-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": "85b52b04-122c-44c9-897e-5216fffe3fbb", "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": "3939c9b5-5d45-4717-a1af-9a3fbdd00a69", "Teams": [ { "TeamId": "00b270c6-1034-454f-bdb5-f08b20e9beab", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d2a14153-6f40-438f-8a24-9f3bcc6b049f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7508c0fb-3778-46a0-baf0-c028e6d9d40d", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d2a14153-6f40-438f-8a24-9f3bcc6b049f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7508c0fb-3778-46a0-baf0-c028e6d9d40d", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ac0ed9b4-6b33-48fd-be9f-3907d869046a", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "00b270c6-1034-454f-bdb5-f08b20e9beab", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d2a14153-6f40-438f-8a24-9f3bcc6b049f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7508c0fb-3778-46a0-baf0-c028e6d9d40d", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d2a14153-6f40-438f-8a24-9f3bcc6b049f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "MeasurementValueNeededDate": "2024-04-23T06:12:02.094459-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7508c0fb-3778-46a0-baf0-c028e6d9d40d", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "ac0ed9b4-6b33-48fd-be9f-3907d869046a", "CreateDate": "2024-04-23T06:12:02.094459-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T06:12:02.094459-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }