Loyalty

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

Returns reference master data required to build member management UIs

Request

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

Responses

Success

Bodyapplication/json

clubsArray of objects(Club)required

Gets the list of club entities available to a member

clubs[].idinteger(int32)required

Gets the unique identifier

clubs[].nameobject(Translatable)required

Gets the name text, and its translations

clubs[].name.textstringnon-emptyrequired

Gets the text in the default language

clubs[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

clubs[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

clubs[].name.translations[].textstringnon-emptyrequired

Gets the translated text

customPreferencesArray of objects(CustomPreference)required

Gets the list of custom preference entities used for setting member custom preference entities

customPreferences[].idinteger(int32)required

Gets the unique identifier

customPreferences[].nameobject(Translatable)required

Gets the name text, and its translations

customPreferences[].name.textstringnon-emptyrequired

Gets the text in the default language

customPreferences[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

customPreferences[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

customPreferences[].name.translations[].textstringnon-emptyrequired

Gets the translated text

customPreferences[].optionQuantityLimitobject(QuantityLimit)required

Gets a value indicating the number of options that can be selected by a member

customPreferences[].optionQuantityLimit.isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

customPreferences[].optionQuantityLimit.maximuminteger or null(int32)

Gets the maximum quantity allowed

customPreferences[].optionQuantityLimit.minimuminteger(int32)required

Gets the minimum quantity allowed (0 by default)

customPreferences[].optionsArray of objects(CustomPreferenceOption)required

Gets the list of custom preference option entities

customPreferences[].options[].idinteger(int32)required

Gets the unique identifier

customPreferences[].options[].nameobject(Translatable)required

Gets the name text, and its translations

customPreferences[].options[].name.textstringnon-emptyrequired

Gets the text in the default language

customPreferences[].options[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

customPreferences[].options[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

customPreferences[].options[].name.translations[].textstringnon-emptyrequired

Gets the translated text

educationLevelsArray of objects(EducationLevel)required

Gets the list of education level entities used for setting member personal details EducationLevelId

educationLevels[].idinteger(int32)required

Gets the unique identifier

educationLevels[].nameobject(Translatable)required

Gets the name text, and its translations

educationLevels[].name.textstringnon-emptyrequired

Gets the text in the default language

educationLevels[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

educationLevels[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

educationLevels[].name.translations[].textstringnon-emptyrequired

Gets the translated text

genresArray of objects(LoyaltyGenre)required

Gets the list of loyalty genre entities used for setting member genre preferences

genres[].idstringnon-emptyrequired

Gets the unique identifier

genres[].nameobject(Translatable)required

Gets the name text, and its translations

genres[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

interestsArray of objects(Interest)required

Gets the list of interest entities used for setting member interest subscription InterestId

interests[].idinteger(int32)required

Gets the unique identifier

interests[].nameobject(Translatable)required

Gets the name text, and its translations

interests[].name.textstringnon-emptyrequired

Gets the text in the default language

interests[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

interests[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

interests[].name.translations[].textstringnon-emptyrequired

Gets the translated text

interests[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

interestContactMethodsArray of objects(InterestContactMethod)required

Gets the list of interest contact method entities used for setting member interest subscription InterestContactMethodIds

interestContactMethods[].idinteger(int32)required

Gets the unique identifier

interestContactMethods[].nameobject(Translatable)required

Gets the name text, and its translations

interestContactMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

interestContactMethods[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

interestContactMethods[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

interestContactMethods[].name.translations[].textstringnon-emptyrequired

Gets the translated text

occupationsArray of objects(Occupation)required

Gets the list of occupation entities used for setting member personal details OccupationId

occupations[].idinteger(int32)required

Gets the unique identifier

occupations[].nameobject(Translatable)required

Gets the name text, and its translations

occupations[].name.textstringnon-emptyrequired

Gets the text in the default language

occupations[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

occupations[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

occupations[].name.translations[].textstringnon-emptyrequired

Gets the translated text

photoRequirementsobject(MemberPhotoRequirements)required

Gets the upload requirements for a member photo

photoRequirements.dimensionsobject(MemberPhotoDimensions)required

Gets the reqiured dimensions

photoRequirements.dimensions.widthinteger(int32)required

Gets the required width in pixels

photoRequirements.dimensions.heightinteger(int32)required

Gets the required height in pixels

photoRequirements.maximumFileSizeInKilobytesinteger(int32)required

Gets the maximum allowed file size in kilobytes

photoRequirements.minimumDaysBetweenUpdatesinteger(int32)required

Gets the minimum number of days allowed between photo updates

sitesArray of objects(LoyaltySite)required

Gets the list of loyalty site entities used for setting member site preferences

sites[].locationobject(GeographicLocation)

Gets the geographic location

sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

sites[].contactDetails.emailstring or null

Gets the email address

sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

sites[].idstringnon-emptyrequired

Gets the unique identifier

sites[].nameobject(Translatable)required

Gets the name text, and its translations

sites[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

sites[].hasSellableItemsbooleanrequired

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

sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

friendConfigurationobject(MemberFriendConfiguration)required

Gets the friend configuration

friendConfiguration.isSubscriptionSharingRestrictedToActiveSubscribersbooleanrequired

Gets a value indicating whether the member friend subscription sharing functionality is restricted to member entities with an active member subscription

friendConfiguration.friendLimitobject(Quantity)required

Gets the maximum number of member friend entities that a member can have

friendConfiguration.friendLimit.isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

friendConfiguration.friendLimit.valueinteger or null(int32)

Gets the value

externalAuthenticationIssuersArray of objects(ExternalAuthenticationIssuer)required

Gets the list of external authentication issuer entities that can be used to authenticate Loyalty members without requiring them to create a password for Loyalty

externalAuthenticationIssuers[].idstringnon-emptyrequired

Gets the identifier of the external authentication issuer

Response

application/json

{
  "clubs": [
    { … }
  ],
  "customPreferences": [
    { … }
  ],
  "educationLevels": [
    { … }
  ],
  "genres": [
    { … }
  ],
  "interests": [
    { … }
  ],
  "interestContactMethods": [
    { … }
  ],
  "occupations": [
    { … }
  ],
  "photoRequirements": {
    "dimensions": { … },
    "maximumFileSizeInKilobytes": 0,
    "minimumDaysBetweenUpdates": 0
  },
  "sites": [
    { … }
  ],
  "friendConfiguration": {
    "isSubscriptionSharingRestrictedToActiveSubscribers": true,
    "friendLimit": { … }
  },
  "externalAuthenticationIssuers": [
    { … }
  ]
}

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.

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

Vista Digital Platform (V1)

Completed Order Assets

Completed Orders

Orders

Seats

Discounts

Events

Showtimes

Films

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Returns reference master data required to build member management UIs

Request

Licenses Required

Responses

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

Request

Error Response

Licenses Required

Responses

Authentication

Members

Member Completed Orders

Friends

Password Reset

Payments

Member Rewards

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

Completion

Gift shop

Vouchers

Refunds

Seating

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips