API docs by Redocly

Westfield Movie APIs (1)

Download OpenAPI specification:Download

Summary of Westfield Movie API endpoints.

MOVIE INFORMATION

List movies and session times.

Request an array of movies filtered by allowed parameters.

Authorizations:
api_key
path Parameters
centre_id
required
string
Example: sanfrancisco,sydney,london

Centre identifier. Request movies with centre_id. Lowercase code name for a specific centre.

query Parameters
date
string <date>
Example: date=2015-07-30

Play date. Request the movies playing on play date.

end_date
string <date>
Example: end_date=2015-07-22

End date. Request the movies playing on or before end date of a range.

fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

page
integer
Default: 1
Example: page=2

Results page number. Specific page of results to request when paginating.

per_page
integer
Default: 10
Example: per_page=25

Results per page. Number of items per result set when paginating.

start_date
string <date>
Example: start_date=2015-07-22

Start date. Request the movies playing on or after start date of a range.

updated_since
string <date-time>
Example: updated_since=2015-04-02

Updated since. Request the movies updated since a specific date and time. ISO-8601 format.

Responses

Response samples

Content type
application/json
{}

Individual movie and session times.

Request a single movie.

Authorizations:
api_key
path Parameters
centre_id
required
string
Example: sanfrancisco,sydney,london

Centre identifier. Request the movie with centre_id. Lowercase code name for a specific centre.

movie_id
required
integer <int64>
Example: 4592

Movie identifier. Request the movie with movie_id.

query Parameters
end_date
string <date>
Example: end_date=2015-07-22

End date. Request the sessions of this movie playing on or before end date of a range.

fields
string
Example: fields=_links

Fields in response. Array that lists the fields requested. If empty or not supplied, all attributes will be returned.

start_date
string <date>
Example: start_date=2015-07-22

Start date. Request the sessions of this movie playing on or after start date of a range.

Responses

Response samples

Content type
application/json
{}

Request to run task

Request to run task

Authorizations:
api_keytask
Request Body schema: application/json
task
required
string

Task name

Responses

Request samples

Content type
application/json
{
  • "task": "populate-centers"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": { },
  • "meta": {
    }
}