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": "41ef6ee3-58a5-4036-a000-31ea9ae3cd71", "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": "9aa1cd84-e5f9-4087-8a08-5e2b83d57336", "Teams": [ { "TeamId": "d066f778-b856-4e6a-b83c-3de3640f05ec", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b52400a8-a231-44ba-97de-dbeda9fe36ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36447efd-8588-4168-8871-12c8c91689b3", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b52400a8-a231-44ba-97de-dbeda9fe36ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36447efd-8588-4168-8871-12c8c91689b3", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3468811a-70ba-4e58-a025-00037f6d3250", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d066f778-b856-4e6a-b83c-3de3640f05ec", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "b52400a8-a231-44ba-97de-dbeda9fe36ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36447efd-8588-4168-8871-12c8c91689b3", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "b52400a8-a231-44ba-97de-dbeda9fe36ba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "36447efd-8588-4168-8871-12c8c91689b3", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3468811a-70ba-4e58-a025-00037f6d3250", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-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": "a9ba5e96-e7cd-4cd8-ba3b-a427756aba7d", "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": "ba1f9229-e835-4c94-a511-b2da039de44b", "Teams": [ { "TeamId": "9cc39973-3188-494c-ae96-e2ddff058cc1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "33c23da9-038e-461b-be95-0f48fd3404b4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecb787ee-1595-49cf-a7ca-2c3054c92483", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "33c23da9-038e-461b-be95-0f48fd3404b4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecb787ee-1595-49cf-a7ca-2c3054c92483", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "62e2f1e5-c2cc-4fbf-a5b6-5e8524ec14b0", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9cc39973-3188-494c-ae96-e2ddff058cc1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "33c23da9-038e-461b-be95-0f48fd3404b4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecb787ee-1595-49cf-a7ca-2c3054c92483", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "33c23da9-038e-461b-be95-0f48fd3404b4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "MeasurementValueNeededDate": "2025-07-06T15:06:01.2320108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ecb787ee-1595-49cf-a7ca-2c3054c92483", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "62e2f1e5-c2cc-4fbf-a5b6-5e8524ec14b0", "CreateDate": "2025-07-06T15:06:01.2320108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:06:01.2320108-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }