API docs by Redocly

Westfield Kiosk APIs (1)

Download OpenAPI specification:Download

Information on shopping promotions at Westfield malls.

KIOSK

List enclosures.

Request an array of enclosures filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request enclosures associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create an enclosure.

Request creation of an enclosure 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 an enclosure.

kiosk_centre_id
required
integer

Kiosk centre identifier.

name
string

Enclosure name.

waypoint_id
string

Waypoint identifier.

reset_timeout
integer

Enclosure reset timeout in seconds.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "waypoint_id": "string",
  • "reset_timeout": 0
}

Response samples

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

Request a single enclosure.

Request a single enclosure.

Authorizations:
api_key
path Parameters
enclosure_id
required
integer

Enclosure identifier. Request the enclosure with enclosure_id.

Responses

Response samples

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

Update an enclosure.

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

Authorizations:
api_key
path Parameters
enclosure_id
required
integer

Enclosure identifier. Request to update the enclosure with enclosure_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 an enclosure.

kiosk_centre_id
integer

Kiosk centre identifier.

name
string

Enclosure name.

reset_timeout
integer

Enclosure reset timeout.

waypoint_id
string

Waypoint identifier.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "reset_timeout": 0,
  • "waypoint_id": "string"
}

Response samples

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

Delete an enclosure.

Request deletion of an enclosure.

Authorizations:
api_key
path Parameters
enclosure_id
required
integer

Enclosure identifier. Request the enclosure with enclosure_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": {
    }
}

List kiosk centres.

Request an array of centres that have kiosks.

Authorizations:
api_key

Responses

Response samples

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

Create a kiosk centre.

Request creation of a kiosk centre 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 kiosk centre.

category_ids
Array of integers
centre_id
required
string

Centre identifier. Identifier to retrieve the centre related to this kiosk centre.

features
Array of strings
landing_page
string

Kiosk centre landing page.

languages
Array of strings
Items Enum: "en_US" "en_GB" "es_ES" "it_IT" "fr_FR" "de_DE" "pt_PT" "ja_JP" "zh_CN" "ar_SA" "he_IL" "ru_RU"

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "features": [
    ],
  • "landing_page": "string",
  • "languages": [
    ]
}

Response samples

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

Individual kiosk centre.

Request a single kiosk centre.

Authorizations:
api_key
path Parameters
kiosk_centre_id
required
integer
Example: 24585

Kiosk centre identifier. Request the kiosk centre with kiosk_centre_id.

Responses

Response samples

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

Update a kiosk centre.

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

Authorizations:
api_key
path Parameters
kiosk_centre_id
required
integer

Kiosk centre identifier. Request to update the kiosk centre with kiosk_centre_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 kiosk centre.

category_ids
Array of integers
features
Array of strings
landing_page
string

Kiosk centre landing page.

languages
Array of strings
Items Enum: "en_US" "en_GB" "es_ES" "it_IT" "fr_FR" "de_DE" "pt_PT" "ja_JP" "zh_CN" "ar_SA" "he_IL" "ru_RU"

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ],
  • "features": [
    ],
  • "landing_page": "string",
  • "languages": [
    ]
}

Response samples

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

Delete a kiosk centre.

Request deletion of a kiosk centre.

Authorizations:
api_keybearerAuth
path Parameters
kiosk_centre_id
required
integer

Kiosk centre identifier. Request to delete the kioks centre with kiosk_centre_id.

Responses

Response samples

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

List directories.

Request an array of directories.

Authorizations:
api_key
query Parameters
enclosure_id
string

Enclosure identifier. Request directories associated with a kiosk_centre that has enclosure_id.

Responses

Response samples

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

Create a directory.

Request creation of a directory 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 directory.

category_ids
Array of integers

Category identifiers. List of identifiers to retrieve categories related to the centre identified by centre_id.

centre_id
string

Centre identifier. Identifier to retrieve the centre related to this kiosk_centre directory.

enabled
boolean

Directory is enabled (true) or not enabled (false).

enclosure_id
integer

Enclosure identifier. Identifier to retrieve the enclosure related to this kiosk_centre directory.

features
Array of strings

List of features available on this kiosk_centre directory for the centre identified by centre_id.

heading
integer

Directory heading number.

landing_page
string

Landing page for this kiosk_centre directory.

languages
Array of strings
Items Enum: "en_US" "en_GB" "es_ES" "it_IT" "fr_FR" "de_DE" "pt_PT" "ja_JP" "zh_CN" "ar_SA" "he_IL" "ru_RU"

List of languages available on this kiosk_centre directory.

name
string

Directory name.

template
string

Directory template.

waypoint_id
string

Waypoint identifier. Identifier to retrieve the waypoint related to the enclosure for this kiosk-centre directory.

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "enabled": true,
  • "enclosure_id": 0,
  • "features": [
    ],
  • "heading": 0,
  • "landing_page": "string",
  • "languages": [
    ],
  • "name": "string",
  • "template": "string",
  • "waypoint_id": "string"
}

Response samples

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

Individual directory.

Request a single directory.

Authorizations:
api_key
path Parameters
directory_id
required
integer

Directory identifier. Request the directory with directory_id.

Responses

Response samples

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

Update a directory.

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

Authorizations:
api_key
path Parameters
directory_id
required
integer

Directory identifier. Request to update the directory with directory_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 directory.

category_ids
Array of integers

Category identifiers. List of identifiers to retrieve categories related to the centre identified by centre_id.

centre_id
string

Centre identifier. Identifier to retrieve the centre related to this kiosk_centre directory.

enabled
boolean

Directory is enabled (true) or not enabled (false).

enclosure_id
integer

Enclosure identifier. Identifier to retrieve the enclosure related to this kiosk_centre directory.

features
Array of strings

List of features available on this kiosk_centre directory for the centre identified by centre_id.

heading
integer

Directory heading number.

landing_page
string

Landing page for this kiosk_centre directory.

languages
Array of strings
Items Enum: "en_US" "en_GB" "es_ES" "it_IT" "fr_FR" "de_DE" "pt_PT" "ja_JP" "zh_CN" "ar_SA" "he_IL" "ru_RU"

List of languages available on this kiosk_centre directory.

name
string

Directory name.

template
string

Directory template.

waypoint_id
string

Waypoint identifier. Identifier to retrieve the waypoint related to the enclosure for this kiosk-centre directory.

Responses

Request samples

Content type
application/json
{
  • "category_ids": [
    ],
  • "centre_id": "string",
  • "enabled": true,
  • "enclosure_id": 0,
  • "features": [
    ],
  • "heading": 0,
  • "landing_page": "string",
  • "languages": [
    ],
  • "name": "string",
  • "template": "string",
  • "waypoint_id": "string"
}

Response samples

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

Delete a directory.

Request deletion of a directory.

Authorizations:
api_key
path Parameters
directory_id
required
integer

Directory identifier. Request to delete the directory with directory_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": {
    }
}

List slugs.

Request an array of slugs filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request slugs associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create a slug.

Request creation of a slug 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 slug.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this slug.

value
required
string

Value of slug.

slug_description
required
string

Description of slug.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "value": "string",
  • "slug_description": "string"
}

Response samples

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

Request a single slug.

Request a single slug.

Authorizations:
api_key
path Parameters
slug_id
required
integer

Slug identifier. Request the slug with slug_id.

Responses

Response samples

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

Update a slug.

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

Authorizations:
api_key
path Parameters
slug_id
required
integer

Slug identifier. Request to update the slug with slug_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 slug.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this slug.

slug_description
required
string

Description of slug.

value
required
integer

Value of slug.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "slug_description": "string",
  • "value": 0
}

Response samples

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

Delete a slug.

Request deletion of a slug.

Authorizations:
api_key
path Parameters
slug_id
required
integer

Slug identifier. Request the slug with slug_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": {
    }
}

List images.

Request an array of images filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request images associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create an image.

Request creation of an image 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 an image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this image.

image_file_url
string

URI to image file.

slug
string

Abbreviated descriptor to access image.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "image_file_url": "string",
  • "slug": "string"
}

Response samples

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

Request a single image.

Request a single image.

Authorizations:
api_key
path Parameters
image_id
required
integer

Image identifier. Request the image with image_id.

Responses

Response samples

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

Update an image.

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

Authorizations:
api_key
path Parameters
image_id
required
integer

Image identifier. Request to update the image with image_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 an image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this image.

image_file_url
string

URI to image file.

slug
string

Abbreviated descriptor to access image.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "image_file_url": "string",
  • "slug": "string"
}

Response samples

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

Delete an image.

Request deletion of an image.

Authorizations:
api_key
path Parameters
image_id
required
integer

Image identifier. Request the image with image_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": {
    }
}

List hotkeys.

Request an array of images filtered by allowed parameters.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request hotkeys associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create a hotkey.

Request creation of a hotkey 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 hotkey.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this hotkey.

description
required
string

Amenity description to access amenity from map data.

order
required
integer

Hotkey display order.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "description": "string",
  • "order": 0
}

Response samples

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

Request a single hotkey.

Request a single hotkey.

Authorizations:
api_key
path Parameters
hotkey_id
required
integer

Hotkey identifier. Request the hotkey with hotkey_id.

Responses

Response samples

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

Update a hotkey.

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

Authorizations:
api_key
path Parameters
hotkey_id
required
integer

Hotkey identifier. Request to update the hotkey with hotkey_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 hotkey.

kiosk_centre_id
required
integer

Kiosk centre identifier.

description
string

Amenity description.

order
integer

Hotkey display order.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "description": "string",
  • "order": 0
}

Response samples

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

Delete a hotkey.

Request deletion of a hotkey.

Authorizations:
api_key
path Parameters
hotkey_id
required
integer

Hotkey identifier. Request the hotkey with hotkey_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": {
    }
}

List custom styles.

Request an array of custom styles.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request directories associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create a custom style.

Request creation of a custom style 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 custom style.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this custom style.

style_attribute
required
string

Custom style attribute.

style_value
required
string

Custom style value.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "style_attribute": "string",
  • "style_value": "string"
}

Response samples

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

Individual custom style.

Request a single custom_style.

Authorizations:
api_key
path Parameters
custom_style_id
required
integer

Custom style identifier. Request the custom style with custom_style_id.

Responses

Response samples

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

Update a custom style.

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

Authorizations:
api_key
path Parameters
custom_style_id
required
integer

Custom style identifier. Request to update the custom style with custom_style_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 custom style.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this custom style.

style_attribute
required
string

Custom style attribute.

style_value
required
string

Custom style value.

Responses

Request samples

Content type
application/json
{
  • "kiosk_centre_id": 0,
  • "style_attribute": "string",
  • "style_value": "string"
}

Response samples

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

Delete a custom style.

Request deletion of a custom style.

Authorizations:
api_key
path Parameters
custom_style_id
required
integer

Custom style identifier. Request to delete the custom style with custom_style_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": {
    }
}

List stations.

Request an array of stations.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request stations associated with a kiosk_centre that has centre_id.

line_operator_id
integer

Line operator identifier. Request stations associated with a line operator that has line_operator_id.

Responses

Response samples

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

Create a station.

Request creation of a station 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 station.

accessible_amenity_component_id
integer

Accessible amenity component identifier. Identifier to retrieve the accessible amenity component related to this station.

accessible_waypoint_id
integer

Accessible waypoint identifier. Identifier to retrieve the accessible waypoint related to this station.

amenity_component_id
required
integer

Amenity component identifier. Identifier to retrieve the amenity component related to this station.

created_at
required
string <date-time>

Created at. Date-time that the station was created.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this station.

line_operator_id
required
integer

Line operator identifier. Identifier to retrieve the line operator related to this station.

name
required
string

Station name.

updated_at
required
string <date-time>

Updated at. Date-time the station was last updated.

waypoint_id
required
integer

Waypoint identifier. Identifier to retrieve the waypoint related to this station.

Responses

Request samples

Content type
application/json
{
  • "accessible_amenity_component_id": 0,
  • "accessible_waypoint_id": 0,
  • "amenity_component_id": 0,
  • "created_at": "2018-03-21T21:43:56Z",
  • "kiosk_centre_id": 0,
  • "line_operator_id": 0,
  • "name": "string",
  • "updated_at": "2018-03-21T21:43:56Z",
  • "waypoint_id": 0
}

Response samples

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

Individual station.

Request a single station.

Authorizations:
api_key
path Parameters
station_id
required
integer

Station identifier. Request the station with station_id.

Responses

Response samples

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

Update a station.

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

Authorizations:
api_keybearerAuth
path Parameters
station_id
required
integer

Station identifier. Request to update the station with station_id.

Request Body schema: application/json
required

Data to update a station.

accessible_amenity_component_id
integer

Accessible amenity component identifier. Identifier to retrieve the accessible amenity component related to this station.

accessible_waypoint_id
integer

Accessible waypoint identifier. Identifier to retrieve the accessible waypoint related to this station.

amenity_component_id
required
integer

Amenity component identifier. Identifier to retrieve the amenity component related to this station.

created_at
required
string <date-time>

Created at. Date-time that the station was created.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this station.

line_operator_id
required
integer

Line operator identifier. Identifier to retrieve the line operator related to this station.

name
required
string

Station name.

updated_at
required
string <date-time>

Updated at. Date-time the station was last updated.

waypoint_id
required
integer

Waypoint identifier. Identifier to retrieve the waypoint related to this station.

Responses

Request samples

Content type
application/json
{
  • "accessible_amenity_component_id": 0,
  • "accessible_waypoint_id": 0,
  • "amenity_component_id": 0,
  • "created_at": "2018-03-21T21:43:56Z",
  • "kiosk_centre_id": 0,
  • "line_operator_id": 0,
  • "name": "string",
  • "updated_at": "2018-03-21T21:43:56Z",
  • "waypoint_id": 0
}

Response samples

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

Delete a station.

Request deletion of a station.

Authorizations:
api_keybearerAuth
path Parameters
station_id
required
integer

Station identifier. Request to delete the station with station_id.

Responses

Response samples

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

List line operators.

Request an array of line operators.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request line operators associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create a line operator.

Request creation of a line operator 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 line operator.

created_at
required
string <date-time>

Created at. Date-time that the line operator was created.

icon_image_uri
required
string

URI to icon image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line operator.

name
required
string

Line operator name.

updated_at
required
string <date-time>

Updated at. Date-time the line operator was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": "2018-03-21T21:43:56Z",
  • "icon_image_uri": "string",
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Individual line operator.

Request a single line operator.

Authorizations:
api_key
path Parameters
line_operator_id
required
integer

Line operator identifier. Request the line operator with line_operator_id.

Responses

Response samples

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

Update a line operator.

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

Authorizations:
api_key
path Parameters
line_operator_id
required
integer

Line operator identifier. Request to update the line operator with line_operator_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 line operator.

created_at
required
string <date-time>

Created at. Date-time that the line operator was created.

icon_image_uri
string

URI to icon image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line operator.

name
required
string

Line operator name.

updated_at
required
string <date-time>

Updated at. Date-time the line operator was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": "2018-03-21T21:43:56Z",
  • "icon_image_uri": "string",
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Delete a line operator.

Request deletion of a line operator.

Authorizations:
api_key
path Parameters
line_operator_id
required
integer

Line operator identifier. Request to delete the station with line_operator_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": {
    }
}

List line groups.

Request an array of line groups.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request line groups associated with a kiosk_centre that has centre_id.

station_id
integer

Station identifier. Request line groups associated with a station that has station_id.

Responses

Response samples

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

Create a line group.

Request creation of a line group 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 line group.

created_at
required
string <date-time>

Created at. Date-time that the line group was created.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line group.

name
required
string

Line group name.

station_id
required
integer

Station identifier. Identifier to retrieve the station related to this line group.

updated_at
required
string <date-time>

Updated at. Date-time the line group was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": "2018-03-21T21:43:56Z",
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "station_id": 0,
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Individual line group.

Request a single line group.

Authorizations:
api_key
path Parameters
line_group_id
required
integer

Line group identifier. Request the line group with line_group_id.

Responses

Response samples

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

Update a line group.

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

Authorizations:
api_key
path Parameters
line_group_id
required
integer

Line group identifier. Request to update the line group with line_group_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 line group.

created_at
required
string <date-time>

Created at. Date-time that the line group was created.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line group.

name
required
string

Line group name.

station_id
required
integer

Station identifier. Identifier to retrieve the station related to this line group.

updated_at
required
string <date-time>

Updated at. Date-time the line group was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": "2018-03-21T21:43:56Z",
  • "kiosk_centre_id": 0,
  • "name": "string",
  • "station_id": 0,
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Delete a line group.

Request deletion of a line group.

Authorizations:
api_key
path Parameters
line_group_id
required
integer

Line group identifier. Request to delete the line group with line_group_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": {
    }
}

List lines.

Request an array of lines.

Authorizations:
api_key
query Parameters
centre_id
string

Centre identifier. Request lines associated with a kiosk_centre that has centre_id.

Responses

Response samples

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

Create a line.

Request creation of a line 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 line.

color
required
string

Line color.

created_at
required
string <date-time>

Created at. Date-time that the line was created.

destination
string

Line destination.

icon_image_uri
required
string

URI of icon image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line.

line_group_id
required
integer

Line group identifier. Identifier to retrieve the line group related to this line.

station_id
integer

Station identifier. Identifier to retrieve the station related to this line.

updated_at
required
string <date-time>

Updated at. Date-time the line was last updated.

Responses

Request samples

Content type
application/json
{
  • "color": "#FFFF00",
  • "created_at": "2018-03-21T21:43:56Z",
  • "destination": "string",
  • "icon_image_uri": "string",
  • "kiosk_centre_id": 0,
  • "line_group_id": 0,
  • "station_id": 0,
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Individual line.

Request a single line.

Authorizations:
api_key
path Parameters
line_id
required
integer

Line identifier. Request the line with line_id.

Responses

Response samples

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

Update a line.

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

Authorizations:
api_key
path Parameters
line_id
required
integer

Line identifier. Request to update the line with line_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 line.

color
required
string

Line color.

created_at
required
string <date-time>

Created at. Date-time that the line was created.

destination
string

Line destination.

icon_image_uri
required
string

URI of icon image.

kiosk_centre_id
required
integer

Kiosk centre identifier. Identifier to retrieve the kiosk centre related to this line.

line_group_id
required
integer

Line group identifier. Identifier to retrieve the line group related to this line.

station_id
integer

Station identifier. Identifier to retrieve the station related to this line.

updated_at
required
string <date-time>

Updated at. Date-time the line was last updated.

Responses

Request samples

Content type
application/json
{
  • "color": "#FFFF00",
  • "created_at": "2018-03-21T21:43:56Z",
  • "destination": "string",
  • "icon_image_uri": "string",
  • "kiosk_centre_id": 0,
  • "line_group_id": 0,
  • "station_id": 0,
  • "updated_at": "2018-03-21T21:43:56Z"
}

Response samples

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

Delete a line.

Request deletion of a line.

Authorizations:
api_key
path Parameters
line_id
required
integer

Line identifier. Request to delete the line with line_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": {
    }
}

Request to run task

Request to run task

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

Staff Access token type and token value.

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

Directory healthchecks

Request a directory's healthchecks.

Authorizations:
api_key
path Parameters
directory_id
required
integer

Directory identifier. Request healthchecks with directory_id.

Responses

Response samples

Content type
application/json
{}

Create a healthcheck.

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

Authorizations:
api_key
path Parameters
directory_id
required
integer

Directory identifier. Request to create the healthcheck with directory_id.

Request Body schema: application/json
required

Data to create a healthcheck.

error
required
string

Directory error.

Responses

Request samples

Content type
application/json
{
  • "error": "string"
}

Response samples

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