API docs by Redocly

Westfield Videostream APIs (1)

Download OpenAPI specification:Download

Summary of Westfield Videostream API endpoints.

Videostream

Endpoints related to Videostream

List videostreams.

Request an array of videostreams filtered by allowed parameters.

Authorizations:
api_key
query Parameters
playlist_id
string

Request the videostream with particular playlist.

featured
boolean

Featured videostream. Request to include only featured (true) or not featured (false) videostream. Default is false when not specified.

status
Array of strings
Items Enum: "pending" "upcoming" "active" "archive" "unpublished"

Status. Requests videostreams that include one of the listed statuse.

start_date
string <date>

Start date. Request the videostream start date of a range.

end_date
string <date>

End date. Request the videostream end date of a range.

retailer
Array of integers

Retailer identifier. Request the videostream with retailer_id.

centre
Array of strings

Centre identifier. Request videostream with centre_id. Lowercase code name for a specific centre. Must relate to videostream_id.

country
Array of any
Items Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz"

Country code. Request videostreams with country code. Lowercase two-character code for country.

support_diffusions
Array of integers

Identifiers of channel diffusion (web/mobile/digital directory).

locale
string

Returns localized versions of attributes for all videostreams in response body. defaults to default.

strict
boolean
Default: false

When retrieving localized videostream with :locale parameter, return an empty string if no applicable translation exists.

page
integer
Default: 1

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

per_page
integer <= 100
Default: 10

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

fields
Array of strings
Example: fields=_links,featured,playlist_id

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

Responses

Response samples

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

Create a videostream.

Request creation of a videostream from JSON data in the request body.

Authorizations:
api_keybearerAuth
Request Body schema: application/json
name
required
string

Videostream name

browser_title
string or null

Browser title.

page_title
string or null

Page title.

description
string or null

Videostream description.

comment
string or null

Comment

country
required
string
Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz"

Country

time_zone
required
string

The IANA timezone code for the videostream.

partner_name
string or null

Partner name

video_id
string or null

Video id for videostream

playlist_id
string or null

Playlist id for videostream

featured
boolean

Featured

published
boolean

Published

meta_description
string or null

Meta description.

meta_keywords
string or null

Meta keywords.

category_ids
Array of integers

Identifiers of categories the videostream belongs to

support_diffusions
Array of integers

Identifiers of channel diffusion (web/mobile/digital directory).

starts_at
string or null <date-time>

Date-time the videostream starts.

finishes_at
string or null <date-time>

Date-time the videostream finish.

published_at
string or null <date-time>

Date-time the videostream published.

unpublished_at
string or null <date-time>

Date-time the videostream unpublished.

event_image
string or null

Event image.

rectangle_image
string or null

Rectangle image.

mobile_image
string or null

Mobile image.

centres
Array of strings

array of centre ids

retailers
Array of integers

array of retailer ids

Responses

Request samples

Content type
application/json
{
  • "name": "American black bear",
  • "browser_title": "Browser title",
  • "page_title": "Page title",
  • "description": "This is static description",
  • "comment": "Test comment",
  • "country": "us",
  • "time_zone": "America/Los_Angeles",
  • "partner_name": "firework",
  • "video_id": "12",
  • "playlist_id": "20",
  • "featured": true,
  • "published": true,
  • "meta_description": "Videostream meta description",
  • "meta_keywords": "Videostream meta keyword",
  • "category_ids": [
    ],
  • "support_diffusions": [
    ],
  • "starts_at": "2018-03-21T12:34:56Z",
  • "finishes_at": "2018-03-21T12:34:56Z",
  • "published_at": "2018-03-21T12:34:56Z",
  • "unpublished_at": "2018-03-21T12:34:56Z",
  • "event_image": "https://picsum.photos/event.jpg",
  • "rectangle_image": "https://picsum.photos/rectangle.jpg",
  • "mobile_image": "https://picsum.photos/mobile.jpg",
  • "centres": [
    ],
  • "retailers": [
    ]
}

Response samples

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

Individual videostream.

Request a single videostream.

Authorizations:
api_key
path Parameters
videostream_id
required
integer

Videostream identifier. Request the videostream with videostream_id.

query Parameters
locale
string

Retrieve localized versions of all videostream in response body. Defaults to default.

strict
boolean
Default: false

When retrieving localized videostream with :locale parameter, return an empty string if no applicable translation exists.

Responses

Response samples

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

Update an Videostream.

Request update of an Videostream from JSON data in the request body.

Authorizations:
api_keybearerAuth
path Parameters
videostream_id
required
integer

Videostream identifier. Request the videostream with videostream_id.

query Parameters
locale
string

Update name, description, page_title, meta_description, meta_keywords, browser_title fields in with provided locale.

Request Body schema: application/json
name
string

Videostream name

browser_title
string

Browser title.

page_title
string

Page title.

description
string

Videostream description.

comment
string

Comment

country
string
Enum: "us" "uk" "se" "fr" "es" "nl" "at" "de" "sk" "pl" "dk" "cz"

Country

time_zone
string

The IANA timezone code for the videostream.

partner_name
string

Partner name

video_id
string

Video id for videostream

playlist_id
string

Playlist id for videostream

featured
boolean

Featured

published
boolean

Published

meta_description
string

Meta description.

meta_keywords
string

Meta keywords.

category_ids
Array of integers

Identifiers of categories the videostream belongs to

support_diffusions
Array of integers

Identifiers of channel diffusion (web/mobile/digital directory).

starts_at
string <date-time>

Date-time the videostream starts.

finishes_at
string <date-time>

Date-time the videostream finish.

published_at
string <date-time>

Date-time the videostream published.

unpublished_at
string <date-time>

Date-time the videostream unpublished.

event_image
string

Event image.

rectangle_image
string

Rectangle image.

mobile_image
string

Mobile image.

centres
Array of strings

array of centre ids

retailers
Array of integers

array of retailer ids

Responses

Request samples

Content type
application/json
{
  • "name": "American black bear",
  • "browser_title": "Browser title",
  • "page_title": "Page title",
  • "description": "This is static description",
  • "comment": "Test comment",
  • "country": "us",
  • "time_zone": "America/Los_Angeles",
  • "partner_name": "firework",
  • "video_id": "12",
  • "playlist_id": "20",
  • "featured": true,
  • "published": true,
  • "meta_description": "Videostream meta description",
  • "meta_keywords": "Videostream meta keyword",
  • "category_ids": [
    ],
  • "support_diffusions": [
    ],
  • "starts_at": "2018-03-21T12:34:56Z",
  • "finishes_at": "2018-03-21T12:34:56Z",
  • "published_at": "2018-03-21T12:34:56Z",
  • "unpublished_at": "2018-03-21T12:34:56Z",
  • "event_image": "https://picsum.photos/event.jpg",
  • "rectangle_image": "https://picsum.photos/rectangle.jpg",
  • "mobile_image": "https://picsum.photos/mobile.jpg",
  • "centres": [
    ],
  • "retailers": [
    ]
}

Response samples

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

Delete a videostream.

Request deletion of an videostream.

Authorizations:
api_keybearerAuth
path Parameters
videostream_id
required
integer

Videostream identifier. Request the videostream with videostream_id.

query Parameters
locale
string

Deletes a translation from the data. By passing this query param with a locale you are removing the translation based off of the locale and not the complete videostream data

Responses

Response samples

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

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": {
    }
}

Returns videostream versions.

Request videostream versions.

Authorizations:
(api_keybearerAuth)
path Parameters
videostream_id
required
integer

videostream identifier. Request the videostream version with videostream_id.

query Parameters
page
number
Default: 1
Example: page=2

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

per_page
number <= 100
Default: 10
Example: per_page=25

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

sort
string
Example: sort=created_at desc,created_at asc

Sort results by one field created_at. Change sort order by adding desc or asc after field name

version_action
string
Enum: "create" "update" "destroy"

Version Action. Request for versions with action.

header Parameters
Authorization
required
string^[bB]earer [A-Za-z0-9]{64}$

Staff Access token type and token value.

Responses

Response samples

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