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

Completion

Operations

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Gets the survey for a completed standard order

Request

Only standard orders with a single showtime are applicable for a survey.

A survey that has been completed will return a 200 response, where survey IsCompleted equals true.

Licenses Required

  • Vista.Surveys
Path
orderIdstringrequired

The unique identifier of the completed standard order

Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
surveyobject(Survey)required

Gets the survey entity

survey.​expiresAtstring(date-time)required

Gets the date and time that the survey is set to expire

survey.​pagesArray of objects(SurveyPage)required

Gets the list of survey page entities, sorted by survey page Number

survey.​pages[].​numberinteger(int32)required

Gets the number that can be used to uniquely identify the page within the survey

survey.​pages[].​questionsArray of FilmRatingScaleSurveyQuestion (object) or FilmSuggestionYesNoUnsureSurveyQuestion (object) or RatingScaleSurveyQuestion (object) or YesNoUnsureSurveyQuestion (object)required

Gets the list of survey question base entities, sorted by survey question base Number

One of:

Represents a rating scale survey question that asks the patron to rate an associated film

survey.​pages[].​questions[].​idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the question within the survey

survey.​pages[].​questions[].​numberinteger(int32)required

Gets the number that can be used to uniquely identify the question within the survey page

survey.​pages[].​questions[].​titleobject(Translatable)required

Gets the title text, and its translations

survey.​pages[].​questions[].​title.​textstringnon-emptyrequired

Gets the text in the default language

survey.​pages[].​questions[].​title.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

survey.​pages[].​questions[].​isRequiredbooleanrequired

Gets a value indicating whether a response is required

survey.​pages[].​questions[].​typestring(SurveyQuestionType)required

Gets the type

Enum"RatingScale""YesNoUnsure"
survey.​pages[].​questions[].​displayTypestring(RatingScaleSurveyQuestionDisplayType)required

Gets the display type

Enum"Stars""Numbers"
survey.​pages[].​questions[].​rangeobject(RatingScaleSurveyQuestionRange)required

Gets the range

survey.​pages[].​questions[].​range.​minimumnumber(double)required

Gets the minimum value

survey.​pages[].​questions[].​range.​maximumnumber(double)required

Gets the maximum value

survey.​pages[].​questions[].​range.​stepnumber(double)required

Gets the step value

survey.​pages[].​questions[].​filmIdstringnon-emptyrequired

Gets the unique identifier of the film

survey.​titleobject(Translatable)required

Gets the title text, and its translations

survey.​title.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

survey.​responsesArray of RatingScaleSurveyQuestionResponse (object) or YesNoUnsureSurveyQuestionResponse (object)required

Gets the list of existing survey question response base entities

One of:

Represents the patron's response to a rating scale survey question

survey.​responses[].​questionIdstringnon-emptyrequired

Gets the unique identifier of the survey question base

survey.​responses[].​typestring(SurveyQuestionType)required

Gets the question type

Enum"RatingScale""YesNoUnsure"
survey.​responses[].​responsenumber(double)required

Gets the response

survey.​isCompletedbooleanrequired

Gets a value indicating whether the survey is completed

relatedDataobject(SurveyRelatedData)required

Gets the related data

relatedData.​filmsArray of objects(SurveyRelatedFilm)required

Gets the list of survey related film entities

relatedData.​films[].​idstringnon-emptyrequired
relatedData.​films[].​titleobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

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[].​externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

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

Response
application/json
{
  "survey": {
    "expiresAt": "2019-08-24T14:15:22Z",
    "pages": [ … ],
    "title": { … },
    "responses": [ … ],
    "isCompleted": true
  },
  "relatedData": {
    "films": [ … ]
  }
}

Updates the survey responses for completed standard order

Request

Licenses Required

  • Vista.Surveys
Path
orderIdstringrequired

The unique identifier of the completed standard order

Headers
Connect-Region-Codestring

Region Code

Body
required

The survey responses to be updated

responsesArray of RatingScaleSurveyQuestionResponse (object) or YesNoUnsureSurveyQuestionResponse (object)required

Gets the list of survey question response base entities

One of:

Represents the patron's response to a rating scale survey question

responses[].​questionIdstringnon-emptyrequired

Gets the unique identifier of the survey question base

responses[].​typestring(SurveyQuestionType)required

Gets the question type

Enum"RatingScale""YesNoUnsure"
responses[].​responsenumber(double)required

Gets the response

isCompletedbooleanrequired

Gets a value indicating whether the survey is completed

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/survey/responses' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "responses": [
      {
        "questionId": "string",
        "type": "RatingScale",
        "response": 0.1
      }
    ],
    "isCompleted": true
  }'

Responses

Survey responses updated.

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations