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": "9e8b9621-6123-4a10-83d4-002c9c34842d",
"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": "29dbf393-146b-4c5a-a185-ae3cbcfd08c0",
"Teams": [
{
"TeamId": "e22eb4d8-f0fe-4f62-a009-7a40a7a8f5b3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "710aa292-2814-411b-8e52-09a5cfc55aa5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "81fd18bb-1780-4c8e-bbd7-4797040f2a39",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "710aa292-2814-411b-8e52-09a5cfc55aa5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "81fd18bb-1780-4c8e-bbd7-4797040f2a39",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "acf647cc-5361-477c-b181-c8ea57f7e1a1",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "e22eb4d8-f0fe-4f62-a009-7a40a7a8f5b3",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "710aa292-2814-411b-8e52-09a5cfc55aa5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "81fd18bb-1780-4c8e-bbd7-4797040f2a39",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "710aa292-2814-411b-8e52-09a5cfc55aa5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "81fd18bb-1780-4c8e-bbd7-4797040f2a39",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "acf647cc-5361-477c-b181-c8ea57f7e1a1",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-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": "7bb8c8d2-c3af-40e5-9f64-3614ba7dd213",
"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": "9c3398a2-2f32-48e6-86a6-51051dc3776c",
"Teams": [
{
"TeamId": "aca09805-b7b9-46d4-af3d-1a805be8c32f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0fe7b1ab-bacd-42b5-b997-ffd9811101d5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "18dbc577-f1dc-4bd1-8e72-4808275b2428",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0fe7b1ab-bacd-42b5-b997-ffd9811101d5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "18dbc577-f1dc-4bd1-8e72-4808275b2428",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d5c69d40-873d-4ad1-bf46-d12ed135c5d8",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "aca09805-b7b9-46d4-af3d-1a805be8c32f",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "0fe7b1ab-bacd-42b5-b997-ffd9811101d5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "18dbc577-f1dc-4bd1-8e72-4808275b2428",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "0fe7b1ab-bacd-42b5-b997-ffd9811101d5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"MeasurementValueNeededDate": "2025-02-05T06:13:08.5646118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "18dbc577-f1dc-4bd1-8e72-4808275b2428",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "d5c69d40-873d-4ad1-bf46-d12ed135c5d8",
"CreateDate": "2025-02-05T06:13:08.5646118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T06:13:08.5646118-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}