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": "60e80d0a-deb1-4a8c-8fa6-edacef0547fd", "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": "4a73d298-2cd6-459c-aaa0-a2917c1024c8", "Teams": [ { "TeamId": "34e15ef3-6f58-4367-a331-95a008775121", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1e5515ec-c665-43da-a466-400438f3a5bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02b32953-fe42-4d1c-8a34-ab429521c68c", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1e5515ec-c665-43da-a466-400438f3a5bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02b32953-fe42-4d1c-8a34-ab429521c68c", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "da293b33-ac22-4114-8d4c-54fcc9741266", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "34e15ef3-6f58-4367-a331-95a008775121", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "1e5515ec-c665-43da-a466-400438f3a5bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02b32953-fe42-4d1c-8a34-ab429521c68c", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "1e5515ec-c665-43da-a466-400438f3a5bd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02b32953-fe42-4d1c-8a34-ab429521c68c", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "da293b33-ac22-4114-8d4c-54fcc9741266", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-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": "6578644d-306e-48a2-9c36-7398d2b7d812", "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": "54beb3bf-4d13-43d4-a340-48d319adceae", "Teams": [ { "TeamId": "f36639b7-fd83-4bf6-af65-bce35671dcfb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5711166b-6113-49e8-99cc-1fcad4f0056e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "74ab0c8c-f842-493a-8f51-ead4ed05229a", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5711166b-6113-49e8-99cc-1fcad4f0056e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "74ab0c8c-f842-493a-8f51-ead4ed05229a", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1634cdd5-eba3-4b35-a095-7c6b93dced00", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "f36639b7-fd83-4bf6-af65-bce35671dcfb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "5711166b-6113-49e8-99cc-1fcad4f0056e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "74ab0c8c-f842-493a-8f51-ead4ed05229a", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "5711166b-6113-49e8-99cc-1fcad4f0056e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "MeasurementValueNeededDate": "2024-04-28T20:48:20.2490956-07:00", "SourceSystemId": "sample string 3", "CompanyId": "74ab0c8c-f842-493a-8f51-ead4ed05229a", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1634cdd5-eba3-4b35-a095-7c6b93dced00", "CreateDate": "2024-04-28T20:48:20.2490956-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T20:48:20.2490956-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }