Gets a list of showtime entities for today and tomorrow for a screen

This endpoint is currently used to find an in-progress or imminent showtime given a screen ID, which can then be used as the showtime context for an in-seat delivery order.

showtime entities for the 48 hours from the beginning (i.e. 00:00) of today's calendar date up to the end of the next calendar day are returned. This is to cater for the scenario where this endpoint is called close to the end of the day, such that the next day's showtimes are needed as well.

showtime entities that started on the previous calendar date, but finish on today's calendar date are included.

showtime entities that do not support or are not yet available for in-seat delivery are still included so that this can be communicated to patrons.

Unlike endpoints based on business date, the cutoff for each calendar day is always midnight.

Licenses Required

Vista.Ocapi

Request

path Parameters

screenId

required

string

The unique identifier of the screen

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Not Found

get/ocapi/v1/showtimes/by-screen/{screenId}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"showtimes": [{"id": "string",
"schedule": {"businessDate": "2019-08-24T14:15:22Z",
"startsAt": "2019-08-24T14:15:22Z",
"endsAt": "2019-08-24T14:15:22Z",
"filmStartsAt": "2019-08-24T14:15:22Z",
"filmEndsAt": "2019-08-24T14:15:22Z",
"inSeatItemDelivery": {"startsAt": "2019-08-24T14:15:22Z",
"endsAt": "2019-08-24T14:15:22Z"
}
},
"isSoldOut": true,
"seatLayoutId": "string",
"filmId": "string",
"siteId": "string",
"screenId": "string",
"areaCategories": [{"areaCategoryId": "string",
"isAllocatedSeating": true
}
],
"attributeIds": ["string"
],
"isAllocatedSeating": true,
"requires3dGlasses": true,
"eventId": "string",
"restrictions": ["FilmAdvanceBookingRule"
],
"filmAdvanceBookingRuleId": "string"
}
],
"relatedData": {"sites": [{"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
],
"films": [{"id": "string",
"title": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"synopsis": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortSynopsis": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"censorRatingId": "string",
"censorRatingNote": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"releaseDate": "2019-08-24T14:15:22Z",
"runtimeInMinutes": 0,
"trailerUrl": "http://example.com",
"displayPriority": 0,
"castAndCrew": [{"castAndCrewMemberId": "string",
"roles": ["Actor"
]
}
],
"genreIds": ["string"
],
"externalIds": {"moviexchangeReleaseId": "6ce6697a-16c1-46a9-acef-0a6ce948a353",
"corporateId": "string"
},
"hopk": "string",
"hoCode": "string",
"eventId": "string",
"distributorName": "string"
}
],
"castAndCrew": [{"id": "string",
"name": {"givenName": "string",
"familyName": "string",
"middleName": "string"
}
}
],
"genres": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"censorRatings": [{"id": "string",
"classification": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"classificationDescription": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"ageRestriction": {"minimumAge": 0
}
}
],
"attributes": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"importantMessage": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"displayPriority": 0,
"isPromoted": true
}
],
"screens": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"events": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"schedule": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"siteIds": ["string"
]
}
],
"filmAdvanceBookingRules": [{"id": "string",
"filmId": "string",
"siteId": "string",
"bookingPeriods": [{"startsAt": "2019-08-24T14:15:22Z",
"orderBookingModes": ["Paid"
],
"restriction": "None",
"rewardId": 0
}
]
}
],
"areaCategories": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"hopk": "string",
"isAllocatedSeating": true,
"isInSeatItemDeliveryAvailable": true
}
]
},
"businessDate": "2019-08-24T14:15:22Z"
}