Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order

Can be used to create an 'Add to Calendar' button for a completed standard order

Opening the iCalendar file on a supported device will prompt the patron to add the calendar events to their calendar application.

Licenses Required

  • Vista.Ocapi
Request
path Parameters
orderId
required
string

The unique identifier of the completed standard order

header Parameters
Connect-Region-Code
string

Region Code

Responses
200

Success

404

Order does not exist.

get/ocapi/v1/orders/completed/{orderId}/assets/calendar-event
Request samples
Response samples
application/json
"string"