Gets a film entity by its unique identifier

Digital Platform

Getting Started

Orders

Seating

Loyalty

Subscriptions

Payments

Completed Orders

API Reference

Vista Digital Platform

Completed Order Assets

Completed Orders Assets

Completed Orders

Seats

Discounts

Events

Showtimes

Films

get

Gets a list of film entities

get

Gets a film entity by its unique identifier

get

Gets the current list of film availability entities

get

Gets the current film availability of a particular film

get

Gets Screening Dates

get

Gets the list of film entities for a particular site

get

Gets the current list of film availability entities for a particular site

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Authentication

Members

Friends

Password Reset

Payments

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

BookingFees

Completion

Orders

Gift shop

Vouchers

Refunds

Seating

Sites

3rd Party Member Schemes

Ticket Prices

Tracking Events

Tips

Gets a film entity by its unique identifier

Returns a detailed film and its related data based on the provided filmId.

Licenses Required

Vista.Ocapi

Request

path Parameters

filmId

required

string

The unique identifier of the film

header Parameters

Connect-Region-Code

string

Region Code

Responses

200

Success

404

Film does not exist.

get/ocapi/v1/films/{filmId}

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"film": {"id": "string",
"title": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"synopsis": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortSynopsis": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"censorRatingId": "string",
"censorRatingNote": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"releaseDate": "2019-08-24T14:15:22Z",
"runtimeInMinutes": 0,
"trailerUrl": "http://example.com",
"displayPriority": 0,
"castAndCrew": [{"castAndCrewMemberId": "string",
"roles": ["Actor"
]
}
],
"genreIds": ["string"
],
"externalIds": {"moviexchangeReleaseId": "6ce6697a-16c1-46a9-acef-0a6ce948a353",
"corporateId": "string"
},
"hopk": "string",
"hoCode": "string",
"eventId": "string",
"distributorName": "string"
},
"relatedData": {"castAndCrew": [{"id": "string",
"name": {"givenName": "string",
"familyName": "string",
"middleName": "string"
}
}
],
"genres": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
}
],
"censorRating": {"id": "string",
"classification": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"classificationDescription": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"ageRestriction": {"minimumAge": 0
}
},
"event": {"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"shortName": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"description": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"schedule": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"siteIds": ["string"
]
}
}
}