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.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : AutoMenuLevel

Type: object

Model for an Auto Menu Level

Show Source

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

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

  Example: 1
• hierUnitName(optional): object TranslatedStringHierUnitName
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

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

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

  Example: 1
• options(optional): integer
  A string value of 0???s & 1???s representing the enablement or disablement of the options associated

  Example: 1
• optionsExt(optional): object OptionsExt_AutoMenuLevel
  An object containing the descriptive options list associated with the AutoMenu Level
• start(optional): string
  Indicates the Start Time for every Menu Level in 24-hour format

  Example: 10:10
• subLevelIndex(optional): 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"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedStringHierUnitName"
        },
        "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":"integer",
            "example":1,
            "description":"A string value of 0???s & 1???s representing the enablement or disablement of the options associated"
        },
        "optionsExt":{
            "$ref":"#/definitions/OptionsExt_AutoMenuLevel"
        }
    },
    "description":"Model for an Auto Menu Level"
}

Nested Schema : TranslatedStringHierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "example":{
        "en-US":"Enterprise",
        "de-DE":".....",
        "ar-AR":"....."
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Enterprise",
    "de-DE":".....",
    "ar-AR":"....."
}

Nested Schema : OptionsExt_AutoMenuLevel

Type: object

An object containing the descriptive options list associated with the AutoMenu Level

Show Source

• activeEntry(optional): boolean
  Select to make the selected menu level configuration (1-8) active in the revenue center. Serving Periods, if configured with active levels, override this table.

  Example: false
• activeOnFridays(optional): boolean
  Select to activate the menu level configuration on Fridays.

  Example: false
• activeOnMondays(optional): boolean
  Select to activate the menu level configuration on Mondays.

  Example: false
• activeOnSaturdays(optional): boolean
  Select to activate the menu level configuration on Saturdays.

  Example: false
• activeOnSundays(optional): boolean
  Select to activate the menu level configuration on Sundays.

  Example: false
• activeOnThursdays(optional): boolean
  Select to activate the menu level configuration on Thursdays.

  Example: false
• activeOnTuesdays(optional): boolean
  Select to activate the menu level configuration on Tuesdays.

  Example: false
• activeOnWednesdays(optional): boolean
  Select to activate the menu level configuration on Wednesdays.

  Example: false

{
    "type":"object",
    "properties":{
        "activeEntry":{
            "type":"boolean",
            "example":false,
            "description":"Select to make the selected menu level configuration (1-8) active in the revenue center. Serving Periods, if configured with active levels, override this table."
        },
        "activeOnSundays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Sundays."
        },
        "activeOnMondays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Mondays."
        },
        "activeOnTuesdays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Tuesdays."
        },
        "activeOnWednesdays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Wednesdays."
        },
        "activeOnThursdays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Thursdays."
        },
        "activeOnFridays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Fridays."
        },
        "activeOnSaturdays":{
            "type":"boolean",
            "example":false,
            "description":"Select to activate the menu level configuration on Saturdays."
        }
    },
    "description":"An object containing the descriptive options list associated with the AutoMenu 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: integer
  Unique reference of the hierarchy unit

  Example: 1
• index: 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(optional): string
  A short, human-readable summary of the problem.

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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