Show Source

• activeDaysOfWeek: string
  A string of values 0s and 1s of length 7 representing the days of the week when the serving period is active, starting with Sunday.

  Example: 1111111
• dataExtensions: array dataExtensions
  An array of data extensions for the serving period
• defaultMainLevel: integer
  The object number of the Default Main Level to use when the serving period is active. Valid range is [0-8].

  Example: 1
• defaultSubLevel: integer
  The object number of the Default Sub Level to use when the serving period is active. Valid range is [0-8].

  Example: 1
• endTime: string
  End time of the serving period in 24-hour HH:MM format.

  Example: 11:59
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the serving period is configured.

  Example: 3599
• name(required): object name
  Serving period name
• objectNum(required): integer
  Object number of the serving period.

  Example: 1
• startTime: string
  Start time of the serving period in 24-hour HH:MM format.

  Example: 03:00
• tableCount: integer
  Determines the number of tables available during the serving period.

  Example: 12
• taxesEnabled: string
  A string of values 0s and 1s of length 64 representing the tax rates used when the serving period is active.

  Example: 1000000000000000000000000000000000000000000000000000000000000001

{
    "description":"Model for Serving Period Object Insert and Update Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object number of the serving period.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the serving period is configured. ",
            "type":"integer",
            "example":3599
        },
        "name":{
            "description":"Serving period name",
            "type":"object",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "startTime":{
            "description":"Start time of the serving period in 24-hour HH:MM format.",
            "type":"string",
            "example":"03:00"
        },
        "endTime":{
            "description":"End time of the serving period in 24-hour HH:MM format.",
            "type":"string",
            "example":"11:59"
        },
        "activeDaysOfWeek":{
            "description":"A string of values 0s and 1s of length 7 representing the days of the week when the serving period is active, starting with Sunday.",
            "type":"string",
            "example":"1111111"
        },
        "tableCount":{
            "description":"Determines the number of tables available during the serving period.",
            "type":"integer",
            "example":12
        },
        "defaultMainLevel":{
            "description":"The object number of the Default Main Level to use when the serving period is active. Valid range is [0-8].",
            "type":"integer",
            "example":1
        },
        "defaultSubLevel":{
            "description":"The object number of the Default Sub Level to use when the serving period is active. Valid range is [0-8].",
            "type":"integer",
            "example":1
        },
        "taxesEnabled":{
            "description":"A string of values 0s and 1s of length 64 representing the tax rates used when the serving period is active.",
            "type":"string",
            "example":"1000000000000000000000000000000000000000000000000000000000000001"
        },
        "dataExtensions":{
            "description":"An array of data extensions for the serving period",
            "type":"array",
            "items":{
                "properties":{
                    "columnName":{
                        "description":"Name of the extention field",
                        "type":"string",
                        "example":"extension_Column"
                    },
                    "value":{
                        "description":"Value of the extension field",
                        "type":"string",
                        "example":"value1"
                    }
                }
            }
        }
    }
}

Show Source

• Array of: object items

{
    "description":"An array of data extensions for the serving period",
    "type":"array",
    "items":{
        "properties":{
            "columnName":{
                "description":"Name of the extention field",
                "type":"string",
                "example":"extension_Column"
            },
            "value":{
                "description":"Value of the extension field",
                "type":"string",
                "example":"value1"
            }
        }
    }
}

Show Source

• columnName: string
  Name of the extention field

  Example: extension_Column
• value: string
  Value of the extension field

  Example: value1

{
    "properties":{
        "columnName":{
            "description":"Name of the extention field",
            "type":"string",
            "example":"extension_Column"
        },
        "value":{
            "description":"Value of the extension field",
            "type":"string",
            "example":"value1"
        }
    }
}