Skip to content

Vista Digital Platform (V1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

Discounts

Operations

Events

Operations

Showtimes

Operations

Films

Operations

Gets a list of film entities

Request

Returns a list of film entities along with their related data.

Historical film entities that are no longer playing are not returned by this endpoint.

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/films \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmsArray of objects(Film)required

Gets the list of film entities

films[].​idstringnon-emptyrequired

Gets the unique identifier

films[].​titleobject(Translatable)required

Gets the title text, and its translations

films[].​title.​textstringnon-emptyrequired

Gets the text in the default language

films[].​title.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

films[].​title.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
films[].​title.​translations[].​textstringnon-emptyrequired

Gets the translated text

films[].​synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

films[].​shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

films[].​censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

films[].​censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

films[].​releaseDatestring(date-time)required

Gets the release date of the film

films[].​runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

films[].​trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

films[].​trailers[].​providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"
films[].​trailers[].​uristring(uri)required

Gets the address used for retrieving the trailer

films[].​trailerUrlstring or null(uri)

Gets the trailer video URL

films[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

films[].​castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required
films[].​castAndCrew[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​castAndCrew[].​rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"
films[].​actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​actors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​directors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​producers[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

films[].​externalIdsobject(FilmExternalIds)required

Gets the external identifiers

films[].​externalIds.​moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

films[].​externalIds.​corporateIdstring or null

Gets the unique corporate identifier

films[].​hopkstring or null

Gets the Head Office primary key

films[].​hoCodestringnon-emptyrequired

Gets the Head Office code

films[].​eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

films[].​distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedDataobject(FilmListRelatedData)required

Gets the related data for the film entities

relatedData.​castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.​castAndCrew[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​castAndCrew[].​nameobject(PersonName)required

Gets the person's name

relatedData.​castAndCrew[].​name.​givenNamestring or null

Gets the given name

relatedData.​castAndCrew[].​name.​familyNamestring or null

Gets the family name

relatedData.​castAndCrew[].​name.​middleNamestring or null

Gets the middle or any additional name

relatedData.​genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.​genres[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​genres[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​genres[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​genres[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​genres[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​genres[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​genres[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.​censorRatings[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​censorRatings[].​classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.​censorRatings[].​classification.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​censorRatings[].​classification.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​censorRatings[].​classification.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​censorRatings[].​classification.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​censorRatings[].​classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.​censorRatings[].​ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.​eventsArray of objects(Event)required

Gets the list of related event entities

relatedData.​events[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​events[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​events[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​events[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​events[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​events[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​events[].​shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.​events[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​events[].​scheduleobject(EventSchedule)required

Gets the schedule

relatedData.​events[].​schedule.​startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.​events[].​schedule.​endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.​events[].​siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

Response
application/json
{
  "films": [
    { … }
  ],
  "relatedData": {
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "events": [ … ]
  }
}

Gets a film entity by its unique identifier

Request

Returns a detailed film and its related data based on the provided filmId.

Licenses Required

  • Vista.Ocapi
Path
filmIdstringrequired

The unique identifier of the film

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/films/{filmId}' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmobject(Film)required

Gets the film entity

film.​idstringnon-emptyrequired

Gets the unique identifier

film.​titleobject(Translatable)required

Gets the title text, and its translations

film.​title.​textstringnon-emptyrequired

Gets the text in the default language

film.​title.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

film.​title.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
film.​title.​translations[].​textstringnon-emptyrequired

Gets the translated text

film.​synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

film.​shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

film.​censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

film.​censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

film.​releaseDatestring(date-time)required

Gets the release date of the film

film.​runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

film.​trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

film.​trailers[].​providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"
film.​trailers[].​uristring(uri)required

Gets the address used for retrieving the trailer

film.​trailerUrlstring or null(uri)

Gets the trailer video URL

film.​displayPriorityinteger(int32)required

Gets the display priority used for sorting

film.​castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required
film.​castAndCrew[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

film.​castAndCrew[].​rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"
film.​actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

film.​actors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

film.​directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

film.​directors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

film.​producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

film.​producers[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

film.​genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

film.​externalIdsobject(FilmExternalIds)required

Gets the external identifiers

film.​externalIds.​moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

film.​externalIds.​corporateIdstring or null

Gets the unique corporate identifier

film.​hopkstring or null

Gets the Head Office primary key

film.​hoCodestringnon-emptyrequired

Gets the Head Office code

film.​eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

film.​distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedDataobject(FilmRelatedData)required

Gets the related data for the film entity

relatedData.​castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.​castAndCrew[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​castAndCrew[].​nameobject(PersonName)required

Gets the person's name

relatedData.​castAndCrew[].​name.​givenNamestring or null

Gets the given name

relatedData.​castAndCrew[].​name.​familyNamestring or null

Gets the family name

relatedData.​castAndCrew[].​name.​middleNamestring or null

Gets the middle or any additional name

relatedData.​genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.​genres[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​genres[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​genres[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​genres[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​genres[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​genres[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​genres[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​censorRatingobject(CensorRating)

Gets the related censor rating entity, if applicable

relatedData.​eventobject(Event)

Gets the related event entity, if applicable

Response
application/json
{
  "film": {
    "id": "string",
    "title": { … },
    "synopsis": { … },
    "shortSynopsis": { … },
    "censorRatingId": "string",
    "censorRatingNote": { … },
    "releaseDate": "2019-08-24T14:15:22Z",
    "runtimeInMinutes": 0,
    "trailers": [ … ],
    "trailerUrl": "http://example.com",
    "displayPriority": 0,
    "castAndCrew": [ … ],
    "actors": [ … ],
    "directors": [ … ],
    "producers": [ … ],
    "genreIds": [ … ],
    "externalIds": { … },
    "hopk": "string",
    "hoCode": "string",
    "eventId": "string",
    "distributorName": "string"
  },
  "relatedData": {
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRating": { … },
    "event": { … }
  }
}

Gets the current list of film availability entities

Request

The details of each film availability is based on the collated data of every site that is screening the film.

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/films/availability \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmAvailabilitiesArray of objects(FilmAvailability)required

Gets the list of film availability entities

filmAvailabilities[].​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

filmAvailabilities[].​siteIdstring or null

Gets the unique identifier of the site

filmAvailabilities[].​categoriesArray of strings(FilmCategory)required

Gets the list of film category entities

Items Enum"NowShowing""ComingSoon""AdvanceBooking"
filmAvailabilities[].​showtimeAttributeIdsArray of stringsrequired

Gets the list of unique identifiers of the attribute entities being screened

filmAvailabilities[].​advanceBookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

filmAvailabilities[].​advanceBookingPeriods[].​startsAtstring(date-time)required

Gets the date and time that the booking period starts

filmAvailabilities[].​advanceBookingPeriods[].​orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"
filmAvailabilities[].​advanceBookingPeriods[].​restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"
filmAvailabilities[].​advanceBookingPeriods[].​rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedDataobject(FilmAvailabilityRelatedData)required

Gets the related data for the film availability entities

relatedData.​attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.​attributes[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​attributes[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​attributes[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.​attributes[].​shortName.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​shortName.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​shortName.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​shortName.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​attributes[].​importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.​attributes[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.​attributes[].​isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

Response
application/json
{
  "filmAvailabilities": [
    { … }
  ],
  "relatedData": {
    "attributes": [ … ]
  }
}

Gets the current film availability of a particular film

Request

Licenses Required

  • Vista.Ocapi
Path
filmIdstringrequired

The unique identifier of the film

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/films/{filmId}/availability' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmAvailabilityobject(FilmAvailability)required

Gets the film availability

filmAvailability.​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

filmAvailability.​siteIdstring or null

Gets the unique identifier of the site

filmAvailability.​categoriesArray of strings(FilmCategory)required

Gets the list of film category entities

Items Enum"NowShowing""ComingSoon""AdvanceBooking"
filmAvailability.​showtimeAttributeIdsArray of stringsrequired

Gets the list of unique identifiers of the attribute entities being screened

filmAvailability.​advanceBookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

filmAvailability.​advanceBookingPeriods[].​startsAtstring(date-time)required

Gets the date and time that the booking period starts

filmAvailability.​advanceBookingPeriods[].​orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"
filmAvailability.​advanceBookingPeriods[].​restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"
filmAvailability.​advanceBookingPeriods[].​rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedDataobject(FilmAvailabilityRelatedData)required

Gets the related data for the film availability

relatedData.​attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.​attributes[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​attributes[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​attributes[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.​attributes[].​shortName.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​shortName.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​shortName.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​shortName.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​attributes[].​importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.​attributes[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.​attributes[].​isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

Response
application/json
{
  "filmAvailability": {
    "filmId": "string",
    "siteId": "string",
    "categories": [ … ],
    "showtimeAttributeIds": [ … ],
    "advanceBookingPeriods": [ … ]
  },
  "relatedData": {
    "attributes": [ … ]
  }
}

Gets Screening Dates

Request

Returns a list of dates that have upcoming showtimes, along with details about which films are playing at each site on each day.

Licenses Required

  • Vista.Ocapi
Query
siteIdsArray of stringsunique

Site filter

filmIdsArray of strings

Film filter

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/film-screening-dates?siteIds=string&filmIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmScreeningDatesArray of objects(FilmScreeningDate)required

Gets the list of film screening date entities

filmScreeningDates[].​businessDatestring(date-time)required

Gets the business date

filmScreeningDates[].​filmScreeningsArray of objects(FilmScreening)required

Gets the list of film screening entities

filmScreeningDates[].​filmScreenings[].​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

filmScreeningDates[].​filmScreenings[].​sitesArray of objects(FilmScreeningSite)required

Gets the list of film screening site entities

filmScreeningDates[].​filmScreenings[].​sites[].​siteIdstringnon-emptyrequired

Gets the unique identifier of the site

filmScreeningDates[].​filmScreenings[].​sites[].​showtimeAttributeIdsArray of stringsrequired

Gets the list of unique identifiers of the attribute entities being screened

Response
application/json
{
  "filmScreeningDates": [
    { … }
  ]
}

Gets the list of film entities for a particular site

Request

Returns a list of film entities along with their related data.

Any film entities that are not playing at the requested site are not returned by this endpoint.

Licenses Required

  • Vista.Ocapi
Path
siteIdstringrequired

The unique identifier of the site

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/films' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmsArray of objects(Film)required

Gets the list of film entities

films[].​idstringnon-emptyrequired

Gets the unique identifier

films[].​titleobject(Translatable)required

Gets the title text, and its translations

films[].​title.​textstringnon-emptyrequired

Gets the text in the default language

films[].​title.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

films[].​title.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
films[].​title.​translations[].​textstringnon-emptyrequired

Gets the translated text

films[].​synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

films[].​shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

films[].​censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

films[].​censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

films[].​releaseDatestring(date-time)required

Gets the release date of the film

films[].​runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

films[].​trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

films[].​trailers[].​providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"
films[].​trailers[].​uristring(uri)required

Gets the address used for retrieving the trailer

films[].​trailerUrlstring or null(uri)

Gets the trailer video URL

films[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

films[].​castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required
films[].​castAndCrew[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​castAndCrew[].​rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"
films[].​actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​actors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​directors[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

films[].​producers[].​castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

films[].​genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

films[].​externalIdsobject(FilmExternalIds)required

Gets the external identifiers

films[].​externalIds.​moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

films[].​externalIds.​corporateIdstring or null

Gets the unique corporate identifier

films[].​hopkstring or null

Gets the Head Office primary key

films[].​hoCodestringnon-emptyrequired

Gets the Head Office code

films[].​eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

films[].​distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedDataobject(FilmListRelatedData)required

Gets the related data for the film entities

relatedData.​castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.​castAndCrew[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​castAndCrew[].​nameobject(PersonName)required

Gets the person's name

relatedData.​castAndCrew[].​name.​givenNamestring or null

Gets the given name

relatedData.​castAndCrew[].​name.​familyNamestring or null

Gets the family name

relatedData.​castAndCrew[].​name.​middleNamestring or null

Gets the middle or any additional name

relatedData.​genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.​genres[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​genres[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​genres[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​genres[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​genres[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​genres[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​genres[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.​censorRatings[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​censorRatings[].​classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.​censorRatings[].​classification.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​censorRatings[].​classification.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​censorRatings[].​classification.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​censorRatings[].​classification.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​censorRatings[].​classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.​censorRatings[].​ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.​eventsArray of objects(Event)required

Gets the list of related event entities

relatedData.​events[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​events[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​events[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​events[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​events[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​events[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​events[].​shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.​events[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​events[].​scheduleobject(EventSchedule)required

Gets the schedule

relatedData.​events[].​schedule.​startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.​events[].​schedule.​endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.​events[].​siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

Response
application/json
{
  "films": [
    { … }
  ],
  "relatedData": {
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "events": [ … ]
  }
}

Gets the current list of film availability entities for a particular site

Request

Licenses Required

  • Vista.Ocapi
Path
siteIdstringrequired

The unique identifier of the site

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/films/availability' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
filmAvailabilitiesArray of objects(FilmAvailability)required

Gets the list of film availability entities

filmAvailabilities[].​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

filmAvailabilities[].​siteIdstring or null

Gets the unique identifier of the site

filmAvailabilities[].​categoriesArray of strings(FilmCategory)required

Gets the list of film category entities

Items Enum"NowShowing""ComingSoon""AdvanceBooking"
filmAvailabilities[].​showtimeAttributeIdsArray of stringsrequired

Gets the list of unique identifiers of the attribute entities being screened

filmAvailabilities[].​advanceBookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

filmAvailabilities[].​advanceBookingPeriods[].​startsAtstring(date-time)required

Gets the date and time that the booking period starts

filmAvailabilities[].​advanceBookingPeriods[].​orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"
filmAvailabilities[].​advanceBookingPeriods[].​restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"
filmAvailabilities[].​advanceBookingPeriods[].​rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedDataobject(FilmAvailabilityRelatedData)required

Gets the related data for the film availability entities

relatedData.​attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.​attributes[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​attributes[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​attributes[].​name.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​name.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.​attributes[].​shortName.​textstringnon-emptyrequired

Gets the text in the default language

relatedData.​attributes[].​shortName.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.​attributes[].​shortName.​translations[].​languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"
relatedData.​attributes[].​shortName.​translations[].​textstringnon-emptyrequired

Gets the translated text

relatedData.​attributes[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​attributes[].​importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.​attributes[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.​attributes[].​isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

Response
application/json
{
  "filmAvailabilities": [
    { … }
  ],
  "relatedData": {
    "attributes": [ … ]
  }
}

Gift Cards

Operations

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Member Rewards

Operations

Subscriptions

Operations

Ticket Redemption Cards

Operations

Credentials

Operations

Watched Films

Operations

Watchlist Films

Operations

Completion

Operations

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations