Sessions
Sessions (or showtimes) of a circuit are a key entity as they are an essential part of the ticket selling process. As well as telling customers when a film is showing, a session contains numerous other properties important to their experience including custom attributes, screen/seating information, and ticket selling restrictions.
Session cutoff
The Connect API restricts which sessions are returned based on the session start time. While the exact cut-off rules are configurable within the circuit generally Connect exposes only sessions that are currently playing or playing in the future.
Querying sessions
Sessions can be accessed directly by the Sessions OData endpoint:
/OData.svc/Sessions?$format=json
Or can be returned as expanded properties on the OData ScheduledFilm endpoints:
/Odata.svc/GetNowShowingScheduledFilms?$expand=Sessions&$format=json
Session attributes
Attributes for sessions are available in the SessionAttributesNames
property, or if more detail is required the full Attribute entity can be expanded if required:
/OData.svc/Sessions?$expand=Attributes&$format=json
Marathon (a.k.a. playthrough) sessions
Marathons will be indicated by the existence of the PlayThroughId
property. To retrieve the details of the specific films the PlaythroughFilms OData endpoint can be used
/OData.svc/PlayThroughSessions?$format=json
Private sessions
The Connect API currently does not support private sessions.