POST api/ApplicationScreens

Creates an Application Screen

Request Information

URI Parameters

None.

Body Parameters

The Application Screen Object

VEMModel.VEMModelClass.ApplicationScreen

Name	Type	Additional information
ScreenId	integer	None.
Code	string	None.
ScreenReferenceId	integer	None.
ScreenMenuTitle	string	None.
ScreenMenuIcon	string	None.
ScreenMenuItemGroup	string	None.
ScreenName	string	Max length: 50
ScreenTitle	string	None.
ScreenDescription	string	None.
ForMobile	boolean	None.
ForDesktop	boolean	None.
ForWeb	boolean	None.
WebRoute	string	Max length: 50
DateCreated	date	None.
CreatedBy	string	Max length: 50
UpdatedOn	date	None.
UpdatedBy	string	Max length: 50
ProfileId	integer	None.
Profile	VEMModel.UserAccessControl.Profile	None.
Actions	Collection of VEMModel.UserAccessControl.Action	None.
MenuGroupName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ScreenId": 1,
  "Code": "sample string 2",
  "ScreenReferenceId": 3,
  "ScreenMenuTitle": "sample string 4",
  "ScreenMenuIcon": "sample string 5",
  "ScreenMenuItemGroup": "sample string 6",
  "ScreenName": "sample string 7",
  "ScreenTitle": "sample string 8",
  "ScreenDescription": "sample string 9",
  "ForMobile": true,
  "ForDesktop": true,
  "ForWeb": true,
  "WebRoute": "sample string 13",
  "DateCreated": "2026-04-15T14:57:10.0009423-04:00",
  "CreatedBy": "sample string 14",
  "UpdatedOn": "2026-04-15T14:57:10.0009423-04:00",
  "UpdatedBy": "sample string 15",
  "ProfileId": 1,
  "Profile": {
    "$id": "2",
    "RecordId": 1,
    "Code": "sample string 2",
    "Description": "sample string 3",
    "Deleted": true,
    "DateCreated": "2026-04-15T14:57:10.0009423-04:00",
    "UpdatedOn": "2026-04-15T14:57:10.0009423-04:00",
    "CreatedBy": "sample string 6",
    "UpdatedBy": "sample string 7",
    "Actions": [
      {
        "$id": "3",
        "RecordId": 1,
        "Code": "sample string 2",
        "Description": "sample string 3",
        "Deleted": true,
        "Profiles": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ],
        "DateCreated": "2026-04-15T14:57:10.0009423-04:00",
        "UpdatedOn": "2026-04-15T14:57:10.0009423-04:00",
        "CreatedBy": "sample string 6",
        "UpdatedBy": "sample string 7"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "Actions": [
    {
      "$ref": "3"
    },
    {
      "$ref": "3"
    }
  ],
  "MenuGroupName": "sample string 16"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VEMModel.Logic.APIResponseClass

Name	Type	Additional information
Result	VEMModel.Logic.ResultEnum	None.
Details	Object	None.
JsonData	Object	None.
ObjectType	string	None.
ruleEvaluationResults	Collection of VEMModel.Logic.RuleEvaluationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "ruleEvaluationResults": [
    {
      "$id": "2",
      "Result": 0,
      "Message": "sample string 1",
      "fieldID": "sample string 2"
    },
    {
      "$ref": "2"
    }
  ],
  "Result": 0,
  "Details": {
    "$id": "3"
  },
  "JsonData": {
    "$id": "4"
  },
  "ObjectType": "sample string 3"
}