Jump to

• Request
• Response

Add Auto Menu Levels

post

/config/sim/v2/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 : schema

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

  Example: 1

{
    "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",
            "example":1,
            "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 Added.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

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

  Example: 1

{
    "type":"object",
    "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"
        }
    }
}

Back to Top