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": "c14a2eca-3eb1-4c76-b66c-b97a530f5b5c", "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": "2a261c7d-49eb-4567-90fa-82457880414f", "Teams": [ { "TeamId": "f478c759-f146-41ec-af21-c981d761497a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "651e3708-4ad2-4773-9492-70a44706444e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0c7ef1a0-a15f-49ce-9391-c0104adf910d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "651e3708-4ad2-4773-9492-70a44706444e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0c7ef1a0-a15f-49ce-9391-c0104adf910d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "29723bf2-acd3-4da7-a612-df7655b8656d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "f478c759-f146-41ec-af21-c981d761497a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "651e3708-4ad2-4773-9492-70a44706444e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0c7ef1a0-a15f-49ce-9391-c0104adf910d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "651e3708-4ad2-4773-9492-70a44706444e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0c7ef1a0-a15f-49ce-9391-c0104adf910d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "29723bf2-acd3-4da7-a612-df7655b8656d", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-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": "5cd55a33-29f5-4632-8cc4-8c4c06b0b5bc", "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": "60a6a9ac-9de9-4905-8f4c-68bd802bddb3", "Teams": [ { "TeamId": "3d232bd2-fc90-409b-8fb9-2b7d77c7faf1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3d5ac44e-80d9-480f-9bc4-71d4f447a763", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "65b6d268-94b9-4c4a-b7cc-6cbc82771aaf", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3d5ac44e-80d9-480f-9bc4-71d4f447a763", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "65b6d268-94b9-4c4a-b7cc-6cbc82771aaf", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c2f7265e-358f-4ceb-a9c0-894ae644e0d4", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "3d232bd2-fc90-409b-8fb9-2b7d77c7faf1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3d5ac44e-80d9-480f-9bc4-71d4f447a763", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "65b6d268-94b9-4c4a-b7cc-6cbc82771aaf", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3d5ac44e-80d9-480f-9bc4-71d4f447a763", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "MeasurementValueNeededDate": "2024-04-26T06:09:43.9450768-07:00", "SourceSystemId": "sample string 3", "CompanyId": "65b6d268-94b9-4c4a-b7cc-6cbc82771aaf", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "c2f7265e-358f-4ceb-a9c0-894ae644e0d4", "CreateDate": "2024-04-26T06:09:43.9450768-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T06:09:43.9450768-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }