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

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

Gets the list of member watchlist film entities for the currently authenticated member, and their related data

Request

Licenses Required

  • Vista.Ocapi
Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
filmsArray of objects(MemberWatchlistFilm)required

Gets the list of member watchlist film entities

films[].​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

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

Gets the date and time that the film was added to the watchlist

films[].​watchedAtstring or null(date-time)

Gets the date and time that the member watched the film, if applicable

films[].​displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedDataobject(MemberWatchlistFilmListRelatedData)required

Gets the related data for the member watchlist film entities

relatedData.​filmsArray of objects(Film)required

Gets the list of related film entities

relatedData.​films[].​idstringnon-emptyrequired

Gets the unique identifier

relatedData.​films[].​titleobject(Translatable)required

Gets the title text, and its translations

relatedData.​films[].​title.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​films[].​synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.​films[].​shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.​films[].​censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.​films[].​censorRatingNoteobject(Translatable)

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

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

Gets the release date of the film

relatedData.​films[].​runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

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

Gets the list of film trailer entities

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

Gets the provider

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

Gets the address used for retrieving the trailer

relatedData.​films[].​trailerUrlstring or null(uri)

Gets the trailer video URL

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

Gets the display priority used for sorting

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

Gets the unique identifier of the cast and crew member

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

Gets the list of roles

Items Enum"Actor""Director""Producer"
relatedData.​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

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

Gets the unique identifier of the cast and crew member

relatedData.​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

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

Gets the unique identifier of the cast and crew member

relatedData.​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

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

Gets the unique identifier of the cast and crew member

relatedData.​films[].​genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.​films[].​externalIdsobject(FilmExternalIds)required

Gets the external identifiers

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

Gets the unique identifier of the linked movieXchange film release entity

relatedData.​films[].​externalIds.​corporateIdstring or null

Gets the unique corporate identifier

relatedData.​films[].​hopkstring or null

Gets the Head Office primary key

relatedData.​films[].​hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.​films[].​eventIdstring or null

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

relatedData.​films[].​distributorNamestringnon-emptyrequired

Gets the name of the distributor

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

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

Adds a member watchlist film for the currently authenticated member

Request

Licenses Required

  • Vista.Ocapi
Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Body
required

The details of the film to add to the member's watchlist

filmIdstringnon-emptyrequired

Gets the unique identifier of the film

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/watchlist-films \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "filmId": "string"
  }'

Responses

Member watchlist film created.

Removes a member watchlist film for the currently authenticated member

Request

Licenses Required

  • Vista.Ocapi
Path
filmIdstringrequired

The unique identifier of the film to remove from the member's watchlist

Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

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

Responses

Member watchlist film removed.

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