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": "a8b3e349-145c-49e4-bfd1-9b8e96034267", "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": "fb34539a-eb7c-4af6-acaa-8dd570b29079", "Teams": [ { "TeamId": "24acb648-f430-48ee-9c0a-9cb1407da9a6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "45c0c866-f02c-4667-811b-7b249fe37767", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d076ea9e-9daa-4141-8150-eecfd5cfb57c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "45c0c866-f02c-4667-811b-7b249fe37767", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d076ea9e-9daa-4141-8150-eecfd5cfb57c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a6006232-4b08-4f90-884c-4ced710459bd", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "24acb648-f430-48ee-9c0a-9cb1407da9a6", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "45c0c866-f02c-4667-811b-7b249fe37767", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d076ea9e-9daa-4141-8150-eecfd5cfb57c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "45c0c866-f02c-4667-811b-7b249fe37767", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d076ea9e-9daa-4141-8150-eecfd5cfb57c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a6006232-4b08-4f90-884c-4ced710459bd", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-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": "29a4b83f-dae6-4934-80e0-2733ecfbe81d", "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": "751b80c5-c2d9-4476-8290-9e3d83a7cc46", "Teams": [ { "TeamId": "9f2a5699-ccfc-4d58-a2ac-7281cf3d4cbc", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1a321d60-4bac-47b6-881a-d44263919bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ba3a888c-952a-48b7-85e6-89dee6752c4c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1a321d60-4bac-47b6-881a-d44263919bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ba3a888c-952a-48b7-85e6-89dee6752c4c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "82b9fc13-348f-4e07-b610-208395813155", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "9f2a5699-ccfc-4d58-a2ac-7281cf3d4cbc", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1a321d60-4bac-47b6-881a-d44263919bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ba3a888c-952a-48b7-85e6-89dee6752c4c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1a321d60-4bac-47b6-881a-d44263919bdf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "MeasurementValueNeededDate": "2025-06-25T06:14:56.3745163-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ba3a888c-952a-48b7-85e6-89dee6752c4c", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "82b9fc13-348f-4e07-b610-208395813155", "CreateDate": "2025-06-25T06:14:56.3745163-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:14:56.3745163-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }