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": "fab7127e-1b6d-4e28-a14d-569d846c8560",
"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": "61b95f5f-d6ff-42f9-9e7f-3589e5571a53",
"Teams": [
{
"TeamId": "7d7f94c8-68e9-4a90-93b8-955198d1adf7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "63cb01b1-75bb-4812-8620-97d15066ebd7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7f517c4f-0733-4eef-9d55-130c433f5b67",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "63cb01b1-75bb-4812-8620-97d15066ebd7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7f517c4f-0733-4eef-9d55-130c433f5b67",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6324c762-d40a-4bf3-94fb-8bf384fa7ff5",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "7d7f94c8-68e9-4a90-93b8-955198d1adf7",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "63cb01b1-75bb-4812-8620-97d15066ebd7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7f517c4f-0733-4eef-9d55-130c433f5b67",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "63cb01b1-75bb-4812-8620-97d15066ebd7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7f517c4f-0733-4eef-9d55-130c433f5b67",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "6324c762-d40a-4bf3-94fb-8bf384fa7ff5",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-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": "77aca349-ebd0-487e-9da3-e770db9e3cf9",
"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": "071762cc-a905-4c4e-a0dd-9ecaf1115e1f",
"Teams": [
{
"TeamId": "4286e4f6-8ea5-4b7a-8206-961ffc6e294b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e6b78532-8d5f-4949-9c60-8dc1baf6f098",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e346b53-2086-4914-8997-2e4cd34f84ff",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e6b78532-8d5f-4949-9c60-8dc1baf6f098",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e346b53-2086-4914-8997-2e4cd34f84ff",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7d6390e4-453b-4133-b339-c53faad5f55c",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"TeamId": "4286e4f6-8ea5-4b7a-8206-961ffc6e294b",
"Name": "sample string 1",
"Description": "sample string 2",
"Users": [],
"AssetGroups": [
{
"AssetGroupId": "e6b78532-8d5f-4949-9c60-8dc1baf6f098",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e346b53-2086-4914-8997-2e4cd34f84ff",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
},
{
"AssetGroupId": "e6b78532-8d5f-4949-9c60-8dc1baf6f098",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"MeasurementValueNeededDate": "2024-12-21T19:18:35.1983134-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6e346b53-2086-4914-8997-2e4cd34f84ff",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7d6390e4-453b-4133-b339-c53faad5f55c",
"CreateDate": "2024-12-21T19:18:35.1983134-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T19:18:35.1983134-08:00",
"LastModifiedUser": "sample string 6"
}
]
},
"Total": 1,
"Message": "sample string 1"
}