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": "a2054637-545a-416e-8414-ecfabd826aa2", "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": "62d46ac1-2490-4fd9-becf-649c54a2ae74", "Teams": [ { "TeamId": "9ea9a891-a400-4509-a549-9b7de9f583ab", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "f231c124-7832-4baf-a4fc-3d884792692a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "a4052da5-b709-4282-a42e-809c81cbcc33", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "f231c124-7832-4baf-a4fc-3d884792692a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "a4052da5-b709-4282-a42e-809c81cbcc33", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "38053120-4da7-4401-936b-18802fb00875", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9ea9a891-a400-4509-a549-9b7de9f583ab", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "f231c124-7832-4baf-a4fc-3d884792692a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "a4052da5-b709-4282-a42e-809c81cbcc33", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "f231c124-7832-4baf-a4fc-3d884792692a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "a4052da5-b709-4282-a42e-809c81cbcc33", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "38053120-4da7-4401-936b-18802fb00875", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08: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": "4caf4f4b-a72c-4c0e-829f-a762de12881f", "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": "5cc1a03b-9523-41cc-bcdb-17332044b591", "Teams": [ { "TeamId": "4ad5a771-5004-4585-acd0-3959342dc936", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "94267145-5f70-4cb5-be20-2e9884cf28f5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "d2e354b2-8329-447b-aadd-101603aed5cc", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "94267145-5f70-4cb5-be20-2e9884cf28f5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "d2e354b2-8329-447b-aadd-101603aed5cc", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2ae0c67f-16ad-42d4-82ed-957f6317203b", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "4ad5a771-5004-4585-acd0-3959342dc936", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "94267145-5f70-4cb5-be20-2e9884cf28f5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "d2e354b2-8329-447b-aadd-101603aed5cc", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "94267145-5f70-4cb5-be20-2e9884cf28f5", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "MeasurementValueNeededDate": "2024-12-09T01:12:19.6584494-08:00", "SourceSystemId": "sample string 3", "CompanyId": "d2e354b2-8329-447b-aadd-101603aed5cc", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2ae0c67f-16ad-42d4-82ed-957f6317203b", "CreateDate": "2024-12-09T01:12:19.6584494-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-09T01:12:19.6584494-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }