Jump to

• Request
• Response

Add Auto Menu Levels

post

/config/sim/v1/setup/autoMenuLevels

Add an Auto Menu Level unit of specified organization

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

CUD Request body

Root Schema : AutoMenuLevelCUDRequestBody

Type: object

Model for an Auto Menu Level

Show Source

• end: string
  Indicates the End Time for every Menu Level in 24-hour format

  Example: 20:20
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• index(required): integer
  Object number of the auto menu level

  Example: 1
• mainLevelIndex: integer
  Select the Main Level, if any, that becomes active at the specified time

  Example: 1
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated

  Example: 00000000
• start: string
  Indicates the Start Time for every Menu Level in 24-hour format

  Example: 10:10
• subLevelIndex: integer
  Select the Sub Level, if any, that becomes active at the specified time

{
    "type":"object",
    "required":[
        "hierUnitId",
        "index",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "index":{
            "type":"integer",
            "example":1,
            "description":"Object number of the auto menu level"
        },
        "start":{
            "type":"string",
            "example":"10:10",
            "description":"Indicates the Start Time for every Menu Level in 24-hour format"
        },
        "end":{
            "type":"string",
            "example":"20:20",
            "description":"Indicates the End Time for every Menu Level in 24-hour format"
        },
        "mainLevelIndex":{
            "type":"integer",
            "example":1,
            "description":"Select the Main Level, if any, that becomes active at the specified time"
        },
        "subLevelIndex":{
            "type":"integer",
            "description":"Select the Sub Level, if any, that becomes active at the specified time"
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated"
        }
    },
    "description":"Model for an Auto Menu Level"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Auto Menu Level Response

Body ()

Root Schema : AutoMenuLevelResponse

Type: object

Show Source

• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• index(required): integer
  Object number of the auto menu level

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "index"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the hierarchy unit"
        },
        "index":{
            "type":"integer",
            "example":1,
            "description":"Object number of the auto menu level"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top