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

Gets a list of event entities

Request

Only Head Office defined events are returned.

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/events \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
eventsArray of objects(Event)required

Gets the list of event entities

events[].​idstringnon-emptyrequired

Gets the unique identifier

events[].​nameobject(Translatable)required

Gets the name text, and its translations

events[].​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

events[].​shortNameobject(Translatable)

Gets the short name text, and its translations

events[].​descriptionobject(Translatable)

Gets the description text, and its translations

events[].​scheduleobject(EventSchedule)required

Gets the schedule

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

Gets the start date, if applicable

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

Gets the end date, if applicable

events[].​siteIdsArray of stringsrequired

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

relatedDataobject(EventListRelatedData)required

Gets the related data for the event entities

relatedData.​sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.​sites[].​locationobject(GeographicLocation)

Gets the geographic location

relatedData.​sites[].​contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.​sites[].​contactDetails.​phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.​sites[].​contactDetails.​phoneNumbers[].​typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"
relatedData.​sites[].​contactDetails.​phoneNumbers[].​numberstringnon-emptyrequired

Gets the phone number

relatedData.​sites[].​contactDetails.​emailstring or null

Gets the email address

relatedData.​sites[].​contactDetails.​addressobject(SiteAddress)

Represents the physical address of a site

relatedData.​sites[].​ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"
relatedData.​sites[].​idstringnon-emptyrequired

Gets the unique identifier

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

Gets the name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​sites[].​hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.​sites[].​allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Response
application/json
{
  "events": [
    { … }
  ],
  "relatedData": {
    "sites": [ … ]
  }
}

Gets an event entity by its unique identifier

Request

Only Head Office defined events can be returned.

Licenses Required

  • Vista.Ocapi
Path
eventIdstringrequired

The unique identifier of the event

Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
eventobject(Event)required

Gets the event entity

event.​idstringnon-emptyrequired

Gets the unique identifier

event.​nameobject(Translatable)required

Gets the name text, and its translations

event.​name.​textstringnon-emptyrequired

Gets the text in the default language

event.​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

event.​name.​translations[].​languageTagstringnon-emptyrequired

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

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

Gets the translated text

event.​shortNameobject(Translatable)

Gets the short name text, and its translations

event.​descriptionobject(Translatable)

Gets the description text, and its translations

event.​scheduleobject(EventSchedule)required

Gets the schedule

event.​schedule.​startDatestring or null(date-time)

Gets the start date, if applicable

event.​schedule.​endDatestring or null(date-time)

Gets the end date, if applicable

event.​siteIdsArray of stringsrequired

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

relatedDataobject(EventRelatedData)required

Gets the related data for the event entity

relatedData.​sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.​sites[].​locationobject(GeographicLocation)

Gets the geographic location

relatedData.​sites[].​contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.​sites[].​contactDetails.​phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.​sites[].​contactDetails.​phoneNumbers[].​typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"
relatedData.​sites[].​contactDetails.​phoneNumbers[].​numberstringnon-emptyrequired

Gets the phone number

relatedData.​sites[].​contactDetails.​emailstring or null

Gets the email address

relatedData.​sites[].​contactDetails.​addressobject(SiteAddress)

Represents the physical address of a site

relatedData.​sites[].​ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"
relatedData.​sites[].​idstringnon-emptyrequired

Gets the unique identifier

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

Gets the name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​sites[].​hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.​sites[].​allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Response
application/json
{
  "event": {
    "id": "string",
    "name": { … },
    "shortName": { … },
    "description": { … },
    "schedule": { … },
    "siteIds": [ … ]
  },
  "relatedData": {
    "sites": [ … ]
  }
}

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

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