--- title: "Gets the survey for a completed standard order" method: GET path: "/ocapi/v1/orders/completed/{orderId}/survey" tags: ["Completed Orders", "Surveys"] --- # Gets the survey for a completed standard order `GET /ocapi/v1/orders/completed/{orderId}/survey` ## Request - Base URL: `https://developer.vista.co` (the document declares no server; this is the origin it was published from) - URL: `https://developer.vista.co/ocapi/v1/orders/completed/{orderId}/survey` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) 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 parameters - `orderId` string, required ## Headers - `Connect-Region-Code` string ## Response `200` Success - OcapiV1SurveysSurveyDetails: Represents the details of a survey and its related data - `survey` OcapiV1SurveysSurvey, required: Represents a survey which allows a patron to provide feedback about their experience - `expiresAt` string, date-time, required: Gets the date and time that the survey is set to expire - `pages` OcapiV1SurveysSurveyPage[], required: Gets the list of survey page entities, sorted by survey page Number - `number` integer, required: Gets the number that can be used to uniquely identify the page within the survey - `questions` union[], required: Gets the list of survey question base entities, sorted by survey question base Number - union: Represents the base properties of a question in a survey - OcapiV1SurveysQuestionsFilmRatingScaleSurveyQuestion: Represents a rating scale survey question that asks the patron to rate an associated film - `id` string, required: Gets the identifier that can be used to uniquely identify the question within the survey - `number` integer, required: Gets the number that can be used to uniquely identify the question within the survey page - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `isRequired` boolean, required: Gets a value indicating whether a response is required - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `displayType` 'Stars' | 'Numbers', required: Represents the display type of a rating scale survey question - `range` OcapiV1SurveysQuestionsRatingScaleSurveyQuestionRange, required: Represents the range for a rating scale associated with a rating scale survey question - … - `notApplicableOptionField` OcapiV1SurveysQuestionsSurveyQuestionNotApplicableOptionField: Represents the "not applicable" option field for a survey question base - … - `commentField` OcapiV1SurveysQuestionsSurveyQuestionComment: Represents the comment field for a survey question base - … - `filmId` string, required: Gets the unique identifier of the film - OcapiV1SurveysQuestionsFilmSuggestionYesNoUnsureSurveyQuestion: Represents a yes no unsure survey question associated with a suggested film - `id` string, required: Gets the identifier that can be used to uniquely identify the question within the survey - `number` integer, required: Gets the number that can be used to uniquely identify the question within the survey page - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `isRequired` boolean, required: Gets a value indicating whether a response is required - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `yesOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `noOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `unsureOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `filmId` string, required: Gets the unique identifier of the film - OcapiV1SurveysQuestionsRatingScaleSurveyQuestion: Represents a survey question base of type survey question type RatingScale - `id` string, required: Gets the identifier that can be used to uniquely identify the question within the survey - `number` integer, required: Gets the number that can be used to uniquely identify the question within the survey page - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `isRequired` boolean, required: Gets a value indicating whether a response is required - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `displayType` 'Stars' | 'Numbers', required: Represents the display type of a rating scale survey question - `range` OcapiV1SurveysQuestionsRatingScaleSurveyQuestionRange, required: Represents the range for a rating scale associated with a rating scale survey question - … - `notApplicableOptionField` OcapiV1SurveysQuestionsSurveyQuestionNotApplicableOptionField: Represents the "not applicable" option field for a survey question base - … - `commentField` OcapiV1SurveysQuestionsSurveyQuestionComment: Represents the comment field for a survey question base - … - OcapiV1SurveysQuestionsTextSurveyQuestion: Represents a survey question base of type survey question type Text - `id` string, required: Gets the identifier that can be used to uniquely identify the question within the survey - `number` integer, required: Gets the number that can be used to uniquely identify the question within the survey page - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `isRequired` boolean, required: Gets a value indicating whether a response is required - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `format` OcapiV1SurveysQuestionsTextSurveyQuestionFormat, required: Represents the required response format for a text survey question - … - OcapiV1SurveysQuestionsYesNoUnsureSurveyQuestion: Represents a survey question base of type survey question type YesNoUnsure - `id` string, required: Gets the identifier that can be used to uniquely identify the question within the survey - `number` integer, required: Gets the number that can be used to uniquely identify the question within the survey page - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `isRequired` boolean, required: Gets a value indicating whether a response is required - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `yesOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `noOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `unsureOptionLabel` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `title` OcapiV1Translatable: Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required: Gets the text in the default language - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required: Gets the translated text - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required: Gets the text in the default language - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required: Gets the translated text - `responses` union[], required: Gets the list of existing survey question response base entities - union: Represents the base properties of a response to a survey question base - OcapiV1SurveysResponsesRatingScaleSurveyQuestionResponse: Represents the patron's response to a rating scale survey question - `questionId` string, required: Gets the unique identifier of the survey question base - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `response` number, double, nullable: Gets the response, if applicable - `isNotApplicableOptionSelected` boolean, nullable: Gets a value indicating whether the "not applicable" option was selected by the patron, if applicable - `comment` string, nullable: Gets the comment, if applicable - OcapiV1SurveysResponsesTextSurveyQuestionResponse: Represents the patron's response to a text survey question - `questionId` string, required: Gets the unique identifier of the survey question base - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `response` string, nullable: Gets the response, if applicable - OcapiV1SurveysResponsesYesNoUnsureSurveyQuestionResponse: Represents the patron's response to a yes no unsure survey question - `questionId` string, required: Gets the unique identifier of the survey question base - `type` 'RatingScale' | 'Text' | 'YesNoUnsure', required: Represents the type of a survey question base - `response` 'Yes' | 'No' | 'Unsure': Represents the possible responses to a yes no unsure survey question - `isCompleted` boolean, required: Gets a value indicating whether the survey is completed - `relatedData` OcapiV1SurveysRelatedDataSurveyRelatedData, required: Related data for a survey entity - `films` OcapiV1SurveysRelatedDataSurveyRelatedFilm[], required: Gets the list of survey related film entities - `id` string, required - `title` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - `text` string, required: Gets the text in the default language - `translations` OcapiV1Translation[], required: Gets the translations of the translatable Text in other languages - `languageTag` string, required: Gets the IETF (RFC 4646) language tag that the translation Text has been translated for - `text` string, required: Gets the translated text - `externalIds` OcapiV1BrowsingMasterDataFilmsFilmExternalIds, required: Represents the external identifiers linked to a film - `moviexchangeReleaseId` string, uuid, nullable: Gets the unique identifier of the linked movieXchange film release entity - `corporateId` string, nullable: Gets the unique corporate identifier ## Other responses - `400`: Surveys are not enabled or not applicable for this order. - `404`: Order does not exist, or the survey is not yet available or has expired. ## Changes - **2026-10-09** `41415d239083`: 5 breaking, 6 warning, 11 info - the response property `survey/allOf[subschema #1: Survey]/responses/items/oneOf[subschema #1: RatingScaleSurveyQuestionResponse]/response` became nullable for the status `200` - the response property `survey/allOf[subschema #1: Survey]/responses/items/oneOf[subschema #1: RatingScaleSurveyQuestionResponse]/response` became optional for the status `200` - the response property `survey/allOf[subschema #1: Survey]/responses/items/oneOf[subschema #2: YesNoUnsureSurveyQuestionResponse -> subschema #3: YesNoUnsureSurveyQuestionResponse]/response` became optional for the status `200` - added `#/components/schemas/Ocapi.V1.Surveys.Questions.TextSurveyQuestion` to the `survey/allOf[subschema #1: Survey]/pages/items/questions/items/` response property `oneOf` list for the response status `200` - …18 more [Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/completed/:orderId/survey/get.md) --- [API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)