POST Users
Creates a new user.
Request Information
URI Parameters
None.
Body Parameters
User to be created. UserId should not be filled in.
UserName | 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": "af85a63f-8e24-44d6-b7e3-603cbad8e9a8", "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": "2f45ebbe-72d9-4b33-b870-3ce6beabaf65", "Teams": [ { "TeamId": "3abe1fee-3b09-40dd-8751-491bcddb36bf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5b07c2f4-dc8e-486f-923f-cabbfd152bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7661840f-24f6-4079-b1d4-f59369d0425f", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5b07c2f4-dc8e-486f-923f-cabbfd152bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7661840f-24f6-4079-b1d4-f59369d0425f", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d6d0b5a7-6e18-4b77-bfd9-eecc8c339553", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "3abe1fee-3b09-40dd-8751-491bcddb36bf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5b07c2f4-dc8e-486f-923f-cabbfd152bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7661840f-24f6-4079-b1d4-f59369d0425f", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5b07c2f4-dc8e-486f-923f-cabbfd152bab", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "7661840f-24f6-4079-b1d4-f59369d0425f", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d6d0b5a7-6e18-4b77-bfd9-eecc8c339553", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-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": "5a0b80d9-7595-4d2a-b1e0-d13458575dd6", "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": "89cc0df7-9729-4781-a03d-27fd4cb5e67b", "Teams": [ { "TeamId": "4562a220-d11a-4794-964e-96a740109b7a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4b0c5690-30e6-4637-90cb-feea8f7c8c84", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f20106fc-4815-41e3-a73a-fd9405bf6893", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4b0c5690-30e6-4637-90cb-feea8f7c8c84", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f20106fc-4815-41e3-a73a-fd9405bf6893", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "cf8a8f63-f1ec-426c-bcf1-bffd463f85b2", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "4562a220-d11a-4794-964e-96a740109b7a", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "4b0c5690-30e6-4637-90cb-feea8f7c8c84", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f20106fc-4815-41e3-a73a-fd9405bf6893", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "4b0c5690-30e6-4637-90cb-feea8f7c8c84", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "MeasurementValueNeededDate": "2024-12-26T03:13:41.7385302-08:00", "SourceSystemId": "sample string 3", "CompanyId": "f20106fc-4815-41e3-a73a-fd9405bf6893", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "cf8a8f63-f1ec-426c-bcf1-bffd463f85b2", "CreateDate": "2024-12-26T03:13:41.7385302-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-26T03:13:41.7385302-08:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }