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": "38877ec4-5eb0-4c88-9fb5-46a05c076f2a", "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": "19b6a53e-45bf-4569-94d2-577fd001d0f6", "Teams": [ { "TeamId": "eb8092dd-acc3-41f1-bec1-51920b0b8c77", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9a2e984c-8bc6-4c11-b463-7c6b5d2bf517", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "de6f7e68-1a17-4e94-867a-e2f754eccef2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9a2e984c-8bc6-4c11-b463-7c6b5d2bf517", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "de6f7e68-1a17-4e94-867a-e2f754eccef2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "9c40cdc5-cbbb-469a-9b5b-de9f4268d5b1", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "eb8092dd-acc3-41f1-bec1-51920b0b8c77", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "9a2e984c-8bc6-4c11-b463-7c6b5d2bf517", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "de6f7e68-1a17-4e94-867a-e2f754eccef2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "9a2e984c-8bc6-4c11-b463-7c6b5d2bf517", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "de6f7e68-1a17-4e94-867a-e2f754eccef2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "9c40cdc5-cbbb-469a-9b5b-de9f4268d5b1", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-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": "7fad26b9-9d4f-4178-83aa-b9b612593f9f", "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": "614b396b-7f75-4138-8548-b1aacd92adce", "Teams": [ { "TeamId": "50dfc2e6-d7ae-4619-a261-6607f0a709b7", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5db5d2e1-32d3-4bb2-9d67-e4581b47552f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9d05215a-af71-4281-8ddd-f7cadd82a5d2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5db5d2e1-32d3-4bb2-9d67-e4581b47552f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9d05215a-af71-4281-8ddd-f7cadd82a5d2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0d9fbf2b-88b0-427c-ae4e-82a37272d78b", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "50dfc2e6-d7ae-4619-a261-6607f0a709b7", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5db5d2e1-32d3-4bb2-9d67-e4581b47552f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9d05215a-af71-4281-8ddd-f7cadd82a5d2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5db5d2e1-32d3-4bb2-9d67-e4581b47552f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "MeasurementValueNeededDate": "2024-04-24T07:26:10.8420301-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9d05215a-af71-4281-8ddd-f7cadd82a5d2", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0d9fbf2b-88b0-427c-ae4e-82a37272d78b", "CreateDate": "2024-04-24T07:26:10.8420301-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-24T07:26:10.8420301-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }