API docs by Redocly

Westfield Games Service (1)

Download OpenAPI specification:Download

Information about games for Westfield centres.

Centre Games

Endpoints related to Centre Games

CENTRE GAMES

List games

Request an array of games filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
string
Example: centre_id=sanfrancisco&centre_id=sydney&centre_id=london

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

eligibility
Array of integers

List of eligibility category Ids to be used for additional filtering of results.

fields
Array of strings
Example: fields=_links

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

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

Sort results by one or more fields. Change sort order by adding desc or asc after field name. Supported sort fields are: end_date, finishes_at, published_at, starts_at

status
string
Enum: "pending" "scheduled" "published" "live" "expired"

Filter games by status.

statuses
string
Enum: "pending" "scheduled" "published" "live" "expired"

Filter games by one or more statuses.

support_diffusion
Array of integers

List of support diffusion category Ids to be used for additional filtering of results.

Responses

Response samples

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

Create a game

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

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

Staff Access token type and token value.

Request Body schema: application/json
required

Data to create a game.

centre_id
required
string

Centre the game belongs to

game_name
required
string

Game name

featured
boolean

Featured

omnilab_game_id
string

External ID for Omnilab game integration

published_at
required
string <date-time>

The date-time the game was published

end_date
required
string <date-time>

The date-time the game ends

support_diffusion
required
Array of integers

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

eligibility
Array of integers

Eligibility requirements of game.

news_type_ids
Array of integers

List of news type category IDs associated with the game

Responses

Request samples

Content type
application/json
{
  • "centre_id": "string",
  • "game_name": "string",
  • "featured": true,
  • "omnilab_game_id": "string",
  • "published_at": "2020-01-01T17:17:00.000Z",
  • "end_date": "2020-01-14T00:00:00.000Z",
  • "support_diffusion": [
    ],
  • "eligibility": [
    ],
  • "news_type_ids": [
    ]
}

Response samples

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

Individual game

Request a single game.

Authorizations:
api_key
path Parameters
game_id
required
integer
Example: 58976

Game identifier. Request the game with game_id.

query Parameters
fields
Array of strings
Example: fields=_links

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

Delete a game

Request deletion of a game.

Authorizations:
api_key
path Parameters
game_id
required
integer
Example: 58976

Game identifier. Request the game with game_id.

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

Update a game

Request update of a game from JSON data in the request body.

Authorizations:
api_key
path Parameters
game_id
required
integer
Example: 58976

Game identifier. Request the game with game_id.

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

Staff Access token type and token value.

Request Body schema: application/json
required

Data to update a game.

centre_id
string

Centre the game belongs to

game_name
string

Game name

featured
boolean

Featured

omnilab_game_id
string

External ID for Omnilab game integration

published_at
string <date-time>

The date-time the game was published

end_date
string <date-time>

The date-time the game ends

support_diffusion
Array of integers

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

eligibility
Array of integers

Eligibility requirements of game.

news_type_ids
Array of integers

List of news type category IDs associated with the game

Responses

Request samples

Content type
application/json
{
  • "centre_id": "string",
  • "game_name": "string",
  • "featured": true,
  • "omnilab_game_id": "string",
  • "published_at": "2020-01-01T17:17:00.000Z",
  • "end_date": "2020-01-14T00:00:00.000Z",
  • "support_diffusion": [
    ],
  • "eligibility": [
    ],
  • "news_type_ids": [
    ]
}

Response samples

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