--- title: "Gets a film entity by its unique identifier" method: GET path: "/ocapi/v1/films/{filmId}" tags: ["Films"] --- # Gets a film entity by its unique identifier `GET /ocapi/v1/films/{filmId}` ## 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/films/{filmId}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a detailed film and its related data based on the provided filmId. #### Licenses Required - Vista.Ocapi ## Path parameters - `filmId` string, required ## Headers - `Connect-Region-Code` string ## Response `200` Success - OcapiV1BrowsingMasterDataFilmsFilmDetails: Represents the details of a film entity, and its related data - `film` OcapiV1BrowsingMasterDataFilmsFilm, required: Represents a film entity - `id` string, required: Gets the unique identifier - `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 - `synopsis` 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 - `shortSynopsis` 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 - `censorRatingId` string, nullable: Gets the unique identifier of the censor rating, if applicable - `censorRatingNote` 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 - `releaseDate` string, date-time, required: Gets the release date of the film - `runtimeInMinutes` integer, required: Gets the runtime duration in minutes - `trailers` OcapiV1BrowsingMasterDataFilmsFilmTrailer[], required: Gets the list of film trailer entities - `provider` 'Moviexchange' | 'External', required: Represents the provider of a film trailer - `uri` string, uri, required: Gets the address used for retrieving the trailer - `trailerUrl` string, uri, nullable: Gets the trailer video URL - `displayPriority` integer, required: Gets the display priority used for sorting - `castAndCrew` OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMemberWithRoles[], required - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - `roles` OcapiV1BrowsingMasterDataCastAndCrewMembersCastAndCrewMemberRole[], required: Gets the list of roles - `actors` union[], required: Gets the list of film cast and crew member entities that acted in the film, sorted by billing order - union: Represents a cast and crew member in the context of a particular film - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMember: Represents a cast and crew member in the context of a particular film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMemberWithRoles: Represents a film cast and crew member with the list of roles they play in the creation of a film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - `roles` OcapiV1BrowsingMasterDataCastAndCrewMembersCastAndCrewMemberRole[], required: Gets the list of roles - `directors` union[], required: Gets the list of film cast and crew member entities that directed the film, sorted by billing order - union: Represents a cast and crew member in the context of a particular film - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMember: Represents a cast and crew member in the context of a particular film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMemberWithRoles: Represents a film cast and crew member with the list of roles they play in the creation of a film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - `roles` OcapiV1BrowsingMasterDataCastAndCrewMembersCastAndCrewMemberRole[], required: Gets the list of roles - `producers` union[], required: Gets the list of film cast and crew member entities that produced the film, sorted by billing order - union: Represents a cast and crew member in the context of a particular film - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMember: Represents a cast and crew member in the context of a particular film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - OcapiV1BrowsingMasterDataFilmsFilmCastAndCrewMemberWithRoles: Represents a film cast and crew member with the list of roles they play in the creation of a film - `castAndCrewMemberId` string, required: Gets the unique identifier of the cast and crew member - `roles` OcapiV1BrowsingMasterDataCastAndCrewMembersCastAndCrewMemberRole[], required: Gets the list of roles - `genreIds` string[], required: Gets the list of unique identifiers of the assigned genre entities - `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 - `hopk` string, nullable: Gets the Head Office primary key - `hoCode` string, required: Gets the Head Office code - `eventId` string, nullable: Gets the unique identifier of the event the film is assigned to, if applicable - `distributorName` string, required: Gets the name of the distributor - `relatedData` OcapiV1BrowsingMasterDataFilmsFilmRelatedData, required: Related data for a film entity - `castAndCrew` OcapiV1BrowsingMasterDataCastAndCrewMembersCastAndCrewMember[], required: Gets the list of related cast and crew member entities - `id` string, required: Gets the unique identifier - `name` OcapiV1PersonName, required: Represents the parts of a person's name - `givenName` string, nullable: Gets the given name - `familyName` string, nullable: Gets the family name - `middleName` string, nullable: Gets the middle or any additional name - `genres` OcapiV1BrowsingMasterDataGenresGenre[], required: Gets the list of related genre entities - `id` string, required: Gets the unique identifier - `name` 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 - `description` 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 - `censorRating` OcapiV1BrowsingMasterDataCensorRatingsCensorRating: Represents the censor rating of a film, e.g. R18 - `id` string, required: Gets the unique identifier - `classification` 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 - `classificationDescription` 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 - `ageRestriction` OcapiV1BrowsingMasterDataCensorRatingsCensorRatingAgeRestriction: Represents the age restriction of a censor rating - `minimumAge` integer, required: Gets the minimum age required - `event` OcapiV1BrowsingMasterDataEventsEvent: Represents an occasion for which films can be screened and marketed together, e.g. an annual film festival - `id` string, required: Gets the unique identifier - `name` 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 - `shortName` 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 - `description` 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 - `schedule` OcapiV1BrowsingMasterDataEventsEventSchedule, required: Represents the start and/or end date of an event - `startDate` string, date-time, nullable: Gets the start date, if applicable - `endDate` string, date-time, nullable: Gets the end date, if applicable - `siteIds` string[], required: Gets the list of unique identifiers of the site entities screening the event ## Other responses - `404`: Film does not exist. --- [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)