POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
User| Name | 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": "6ff47950-e3f5-467b-99b2-13090dea7bf3",
"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": "55df85d9-099c-4603-ad99-5f8f6d0a6366",
"Teams": [
{
"TeamId": "b52ad9bb-ca27-4652-b78a-d955452bb8c4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "69dd48c6-c8dc-41ba-bfdc-bd6e40fe8c36",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "33cb13e4-31af-4324-85ef-2780094ffccb",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "69dd48c6-c8dc-41ba-bfdc-bd6e40fe8c36",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "33cb13e4-31af-4324-85ef-2780094ffccb",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7b539a7f-9ade-42e6-a0cf-e165386ca809",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "b52ad9bb-ca27-4652-b78a-d955452bb8c4",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "69dd48c6-c8dc-41ba-bfdc-bd6e40fe8c36",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "33cb13e4-31af-4324-85ef-2780094ffccb",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "69dd48c6-c8dc-41ba-bfdc-bd6e40fe8c36",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "33cb13e4-31af-4324-85ef-2780094ffccb",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7b539a7f-9ade-42e6-a0cf-e165386ca809",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-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": "c4eacfbd-1641-40fa-bf08-de07b6f911e0",
"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": "66c3ba9f-9276-4f24-887f-2231a52ff6f1",
"Teams": [
{
"TeamId": "02cd2c11-a6f6-4b92-ae4b-cc696724b091",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3967fc48-972a-4bbb-903a-69b26da27b88",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02299507-a534-47b6-9308-76f06862f97d",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3967fc48-972a-4bbb-903a-69b26da27b88",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02299507-a534-47b6-9308-76f06862f97d",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9346eba4-7e35-4f10-95b9-2a27ea0c9ca6",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "02cd2c11-a6f6-4b92-ae4b-cc696724b091",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "3967fc48-972a-4bbb-903a-69b26da27b88",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02299507-a534-47b6-9308-76f06862f97d",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "3967fc48-972a-4bbb-903a-69b26da27b88",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"MeasurementValueNeededDate": "2025-06-16T14:08:10.3480119-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "02299507-a534-47b6-9308-76f06862f97d",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9346eba4-7e35-4f10-95b9-2a27ea0c9ca6",
"CreateDate": "2025-06-16T14:08:10.3480119-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-16T14:08:10.3480119-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}