TABLE OF CONTENTS


Event Schedule 


Fields

Field
Description
Notes
idUnique id of this schedule.Read Only
typeType of schedule.  Either 'standard' or 'private'.  Default is 'standard' if not provided.
effectiveStartTimeThe time that this schedule will start being effective.  

Required

ISO-8601

effectiveEndTimeThe date that this schedule will stop being effective.  If not provided then it is assumed that the schedule is permanent, not ending.ISO-8601
nameThe name of the schedule.
descriptionThe description of the schedule.
weekdays

An array of weekdays

  • Can be abbreviated M, Tu, W, Th, F, Sa, Su or full name Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

hoursAn array of hour, quantity objects
  • hour: the hour that the event will happen in the from HH:MM like 13:30 for 1:30PM
  • quantity: the number of events to schedule at this time

rangesAn array of start and end times for General Admission. The venue is open from 09:00 - 14:00 for instance.
ranges.start

hour: the hour that the event will happen in the from HH:MM like 13:30 for 1:30PM


ranges.end

hour: the hour that the event will happen in the from HH:MM like 13:30 for 1:30PM


monthlyFor events that happen on the first Monday of the month
dayOfMonthThe day of month like 16 to happen on the sixteenth of every month.
priceLists[ ]Array of price lists. See Price List Object for details.
salesChannelsArray of sales channels 
salesChannels[x].nameThe name of the channel one of (Online, Customer Rep, Pos, ManualEntry).
salesChannels[x].channelThe channel one of (online, customerRep, pointOfSale, manualEntry).
salesChannels[x].enabledtrue if this schedule supports the specified channel, otherwise false.
capacityThe scheduled capacity for the event.
durationThe scheduled event duration
duration.hour
The number of hours that the event will take.

duration.minutes
The number of minutes that the event will take.

repeatsHow frequently the schedule repeats. Value can be one of these (never, day, week, month, year)
salesRestrictionsArray of sales channels.
ticketConfigTicket Config object. In ACME Backoffice this is called Ticket Layout.Optional
ticketConfig.idUnique ID of this ticket configRequired
ticketConfig.nameThe name of the ticket config
ticketConfig.descriptionThe description of the ticket config
ticketConfig.assignedBoolean. A value of 'true' is required to assign a ticket config to a schedule.Required
ticketConfig.printerConfigs[]Array of printer configs
ticketConfig.printerConfig[x].printerIdUnique ID of this printer config
ticketConfig.printerConfig[x].nameThe name of the printer config
ticketConfig.printerConfig[x].configThe ticket configuration string when the selection is 'custom'Required if selection = custom
ticketConfig.printerConfig[x].selectionThe selection of which level of ticket config to use for each printer:
  • theme - value from the Theme
  • settings - value from the Ticket Config
  • custom - custom value

ticketConfig.printerConfig[x].printerTypeThe type of printer:
  • tickets
  • email


Examples

Weekdays Example

  • One event every Monday, Wednesday and Friday at 10:00, 11:00, 12:00 and two on Monday, Wednesday and Friday at 1:00PM
  • effective the entire 2014 year


Weekdays Example
{
      "id""123",
      "type""standard",
      "name" "MWF schedule",
      "description" "Schedule for Monday, Wednesday and Friday",
      "effectiveStartTime" "2014-01-01T00:00:00-00:00",
      "effectiveEndTime" "2014-12-31T23:59:59-00:00",
      "weekdays" : [
        "M",
        "W",
        "F"
      ],
      "hours" : [
        {
          "hour" : 10,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 11,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 12,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 13,
          "minutes" : 0,
          "quantity" : 2
        }
      ],
      "salesChannels" : [
        {
            "name" "Online",
            "channel" "online",
            "enabled" true
        },
        {
            "name" "pointOfSale",
            "channel" "Pos",
            "enabled" true
        }
      ],
      "priceLists" : [
      {
        "id" "1232-09809",
        "name" "Price List Name",
        "description" "Price List Description",
        "effectiveStartTime" "2014-01-01T00:00:00-00:00",
        "effectiveEndTime" ""2014-04-01T00:00:00-00:00",
        "prices" : [
          {
            "personType" : {
              "id" : "897-12356",
              "name" : "Adult",
              "description" : "18 and older",
              "active" : true,
              "group" : false,
              "defaultPrice" : 0.5,
              "displayOrder" : 1
            },
            "price" : 1.02,
           "primePrice" : 1.03
          }
        ]
      },
      ...
  ]
}


Monthly Example

  • One event the first Monday, Wednesday and Friday of the month at 10:00, 11:00 and 12:00 and two on the first Monday, Wednesday and Friday of the month at 1:00PM
  • This schedule is effective only the second half of the 2014 year, July - December.
Monthly Example
{
      "id""123",
      "name" "First MWF Of Month Schedule",
      "description" "Schedule for First Monday, Wednesday and Friday of each month.",
      "effectiveStartTime" "2014-07-01T00:00:00-00:00",
      "effectiveEndTime" "2014-12-31T23:59:59-00:00",
      "weekdays" : [
        "M",
        "W",
        "F"
      ],
      "hours" : [
        {
          "hour" : 10,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 11,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 12,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 13,
          "minutes" : 0,
          "quantity" : 2
        }
      ],
      "monthly" : [
        "first"
      ]
}


Day Of Month Example

  • One event at 10:00 and 12:00 on the first and fifteenth of every month
  • Two events at 11:00 and 1:00PM on the first and fifteenth of every month
  • effective the entire 2014 year 
Day Of Month Example
{
      "id""123",
      "name" "Day Of Month Schedule",
      "description" "Schedule for First and Fifteenth of the month",
      "effectiveStartTime" "2014-01-01T00:00:00-00:00",
      "effectiveEndTime" "2014-12-31T23:59:59-00:00",
      "hours" : [
        {
          "hour" : 10,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 11,
          "quantity" : 2
        },
        {
          "hour" : 12,
          "minutes" : 0,
          "quantity" : 1
        },
        {
          "hour" : 13,
          "minutes" : 0,
          "quantity" : 2
        }
      ],
      "daysOfMonth" : [
        1, 15
      ]
}


Specific Days Example

  • Events at 10:00, 12:00 and 1:00PM on December 25, 26, 27 and 28th 


End of December
{
   "id" "123",
   "scheduleId" "Schedule-123",
   "name" "End of December",
   "description" "description",
   "effectiveStartTime" :  "2014-01-01T00:00:00-00:00",
   "effectiveEndTime" :  "2015-01-01T00:00:00-00:00",
   "priceLists" : [{
      ...
   }],
   "hours" : [
       {
           "hour" 10,
           "minutes" 0,
           "quantity" 1
       },
       {
           "hour" 12,
           "minutes" 0,
           "quantity" 1
       },
       {
           "hour" 13,
           "minutes" 0,
           "quantity" 1
       }
   ],
   "days" : [
       "2014-12-25",
       "2014-12-26",
       "2014-12-27",
       "2014-12-28"
   ]
}


Ticket Layout Example

  • Assign a Ticket Layout to a schedule
  • Note: It is recommended to do a GET call for the Printers Config API prior to get the printer information to save in the schedule PUT call.


Ticket Layout
{
   "id" : "123",
   "scheduleId" : "Schedule-123",
   "name" : "Ticket Layout",
   "description" : "description",
   ...,

   "ticketConfig": {

     "id": "57b1e54e68d6092cb66246c5",

     "name": "Special Events",

     "description": "Ticket layout for special events",

     "printerConfigs": [

       {

         "printerId": "579fff1279e80c62cf020efd",

         "name": "BOCA Lemur - 200dpi",

         "config": "",

         "selection": "settings",

         "printerType": "tickets"

      },

      {

         "printerId": "579fff1279e80c62cf020efe",

         "name": "BOCA Lemur - 300dpi",

         "config": "",

         "selection": "settings",

         "printerType": "tickets"

      },

      {

         "printerId": "579fff1279e80c62cf020eff",

         "name": "Epson TM-T88V",

         "config": "",

         "selection": "settings",

         "printerType": "tickets"

      },

      {

        "printerId": "579fff1279e80c62cf020f00",

        "name": "Zebra iMZ 320",

        "config": "",

        "selection": "settings",

        "printerType": "tickets"

      },

      {

        "printerId": "579fff1279e80c62cf020f01",

        "name": "Epson TM-P20",

        "config": "",

        "selection": "settings",

        "printerType": "tickets"

      },

      {

        "printerId": "579fff1279e80c62cf020f02",

        "name": "Email",

        "config": "",

        "selection": "custom",

        "printerType": "email"

      }

    ],

    "assigned": true,

}