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": "f7dc45e8-72f0-4506-94cd-2fb0a99abea5",
"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": "1998cb35-c138-4360-8d50-36b26bfde1e6",
"Teams": [
{
"TeamId": "6ce0e7ab-2f76-4fc5-9707-b6637850c5c0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dc41d9b9-beab-4405-b500-12297ed6952b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78e39922-c62b-4ae2-ab92-fb0c62633cb5",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dc41d9b9-beab-4405-b500-12297ed6952b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78e39922-c62b-4ae2-ab92-fb0c62633cb5",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9a71ea5f-ad1a-415e-bcb6-fa0958952f79",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "6ce0e7ab-2f76-4fc5-9707-b6637850c5c0",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "dc41d9b9-beab-4405-b500-12297ed6952b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78e39922-c62b-4ae2-ab92-fb0c62633cb5",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "dc41d9b9-beab-4405-b500-12297ed6952b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "78e39922-c62b-4ae2-ab92-fb0c62633cb5",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9a71ea5f-ad1a-415e-bcb6-fa0958952f79",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-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": "e5cd7e39-7c95-477e-98a9-c1fffd36f011",
"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": "b97c309c-4d36-4f35-9cc9-e0eb371c57a8",
"Teams": [
{
"TeamId": "c59cc349-c0a4-45bd-afb0-6e71f1c6bc5e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ea99814b-21b1-43b1-9c3e-5bca5d2780da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f367f739-2023-498d-a530-01e9e32d026d",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ea99814b-21b1-43b1-9c3e-5bca5d2780da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f367f739-2023-498d-a530-01e9e32d026d",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a5d205d8-f9d6-4b1d-ad56-9659bf5e28e7",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "c59cc349-c0a4-45bd-afb0-6e71f1c6bc5e",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "ea99814b-21b1-43b1-9c3e-5bca5d2780da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f367f739-2023-498d-a530-01e9e32d026d",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "ea99814b-21b1-43b1-9c3e-5bca5d2780da",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"MeasurementValueNeededDate": "2025-11-19T21:23:05.3548833-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f367f739-2023-498d-a530-01e9e32d026d",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "a5d205d8-f9d6-4b1d-ad56-9659bf5e28e7",
"CreateDate": "2025-11-19T21:23:05.3548833-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-19T21:23:05.3548833-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}