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": "6988bd67-dc59-42b7-a29a-559fe778cf78",
"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": "db0e2f02-4f2c-4749-a903-cf012131d2f5",
"Teams": [
{
"TeamId": "255a06b6-9a78-4432-86b6-7367debb7581",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "068fcc62-84fa-4a35-80b1-8061eafbdbbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9df3a642-1810-48af-8ccf-9c3f554b7f65",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "068fcc62-84fa-4a35-80b1-8061eafbdbbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9df3a642-1810-48af-8ccf-9c3f554b7f65",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9275e14b-5ff9-4636-a139-df5a951e8bc4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "255a06b6-9a78-4432-86b6-7367debb7581",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "068fcc62-84fa-4a35-80b1-8061eafbdbbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9df3a642-1810-48af-8ccf-9c3f554b7f65",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "068fcc62-84fa-4a35-80b1-8061eafbdbbc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9df3a642-1810-48af-8ccf-9c3f554b7f65",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9275e14b-5ff9-4636-a139-df5a951e8bc4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-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": "c1e6be9f-2fe0-4a24-90b9-4f4477c08303",
"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": "26abeae7-6d35-410b-9e63-bab5f15611d3",
"Teams": [
{
"TeamId": "70100ad1-8320-4a81-8382-353fc8a4af78",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "00e0df9f-6d78-4446-bed7-26ea82955bec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe798d9a-53c3-4dc9-bb0c-fd75f0b248a4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "00e0df9f-6d78-4446-bed7-26ea82955bec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe798d9a-53c3-4dc9-bb0c-fd75f0b248a4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "860512f5-9a5c-48fa-9808-57ae048ca54b",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "70100ad1-8320-4a81-8382-353fc8a4af78",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "00e0df9f-6d78-4446-bed7-26ea82955bec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe798d9a-53c3-4dc9-bb0c-fd75f0b248a4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "00e0df9f-6d78-4446-bed7-26ea82955bec",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:20:22.0478871-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fe798d9a-53c3-4dc9-bb0c-fd75f0b248a4",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "860512f5-9a5c-48fa-9808-57ae048ca54b",
"CreateDate": "2025-10-13T15:20:22.0478871-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:20:22.0478871-07:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}