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

Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie

Request

The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token).

Providing this cookie with subsequent requests works as an alternative to the LoyaltySessionToken HTTP header.

Sign out is handled by the ExpireAuthenticationCookie method.

When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired.

In addition to the authentication cookie, a second vista-loyalty-member-is-authenticated cookie is returned that can be used by the client to detect whether the patron is authenticated.

Data is to be provided as application/x-www-form-urlencoded form parameters in the format of member workstation authentication request

Unlike the standard member authentication endpoints, the cookie from this endpoint does not have permission to update member details.

Error Response

LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000.

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

Bodymultipart/form-data
grant_typestringrequired
card_numberstring
phone_numberstring
pinstring
usernamestring
emailstring
passwordstring
club_idstring
curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/workstation-authentication-cookie \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: multipart/form-data' \
  -F grant_type=string \
  -F card_number=string \
  -F phone_number=string \
  -F pin=string \
  -F username=string \
  -F email=string \
  -F password=string \
  -F club_id=string

Responses

Member authenticated cookies created.

Creates a friend code for the currently authenticated Loyalty member

Request

A friend code can be redeemed by another member to create a member friend

Licenses Required

  • Vista.Ocapi
  • Vista.Loyalty.Friends
Headers
loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body
required

The values needed to create the member friend code

friendCanUseMemberSubscriptionbooleanrequired

Gets a value indicating whether the created member friend can use the member entity's member subscription

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

Responses

Success

Bodyapplication/json
friendCodestringnon-emptyrequired

Gets the friend code

expiresAtstring(date-time)required

Gets the date and time that the friend code expires

Response
application/json
{
  "friendCode": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}

Adds a friend by creating a member friend using a friend code

Request

Licenses Required

  • Vista.Ocapi
  • Vista.Loyalty.Friends
Headers
loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body
required

The values needed to create the member friend

friendCodestringnon-emptyrequired

Gets the member friend code FriendCode

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

Responses

Success

Bodyapplication/json
friendobject(MemberFriend)required

Gets the member friend entity

friend.​idstring(uuid)required

Gets the unique identifier

friend.​nameobject(PersonName)required

Gets the name

friend.​name.​givenNamestring or null

Gets the given name

friend.​name.​familyNamestring or null

Gets the family name

friend.​name.​middleNamestring or null

Gets the middle or any additional name

friend.​photoobject(MemberPhotoBase)

Gets the photo details

friend.​subscriptionSharingobject(MemberFriendSubscriptionSharing)required

Gets the subscription sharing details

friend.​subscriptionSharing.​friendCanUseMemberSubscriptionbooleanrequired

Gets a value indicating whether the member friend can use the member entity's member subscription

friend.​subscriptionSharing.​friendSubscriptionsArray of objects(MemberFriendSubscription)required

Gets the list of member friend subscription entities that the member can use

friend.​subscriptionSharing.​friendSubscriptions[].​subscriptionIdinteger(int32)required

Gets the unique identifier of the subscription

friend.​createdAtstring(date-time)required

Gets the date and time that the friend was created

relatedDataobject(MemberFriendRelatedData)required

Gets the related data for the member friend entity

relatedData.​subscriptionsArray of objects(Subscription)required

Gets the list of related subscription entities

relatedData.​subscriptions[].​idinteger(int32)required

Gets the unique identifier

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

Gets the name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​subscriptions[].​clubIdinteger(int32)required

Gets the unique identifier of the club

relatedData.​subscriptions[].​minimumTermInMonthsinteger(int32)required

Gets the minimum number of number of months required for the subscription term

relatedData.​subscriptions[].​minimumTermBeforeCanPurchaseFutureSubscriptionInMonthsinteger(int32)required

Gets the minimum number of months that must be completed before purchase of another subscription will be allowed

Response
application/json
{
  "friend": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": { … },
    "photo": { … },
    "subscriptionSharing": { … },
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "relatedData": {
    "subscriptions": [ … ]
  }
}

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