API docs by Redocly

Game API (1.0.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com/ License: MIT Terms of Service

Amusement Connect API for managing and interacting with games.

Device

Device

Game

Game

Get game by the game id

Get game by the game id

Authorizations:
apiKeyaadOauth2
path Parameters
gameId
required
string

The id of the game

query Parameters
costToPlay.type
string

The type of cost to play (credit or cash)

icon.name
string

The variation of the icon to return (thumbnail, focus, etc.)

select
string
Example: select=id,name,description

A comma-separated list of fields to include in the response. If not specified, all fields are returned.

exclude
string
Example: exclude=id,name,description

A comma-separated list of fields to exclude from the response. If not specified, all fields are returned.

expand
string
Example: expand=device,users

A comma-separated list of fields to expand in the response. If not specified, no fields are expanded.

apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

links
boolean

Specifies whether to include links in the response.

header Parameters
Accept-Language
string

The language to use for the response.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "displayName": "string",
  • "status": "enabled",
  • "playable": true,
  • "location": {
    },
  • "costToPlay": [
    ],
  • "icon": {
    },
  • "_links": [
    ],
  • "device": {
    }
}

Requests a game play

Requests a game play

Authorizations:
apiKeyaadOauth2
path Parameters
gameId
required
string

The id of the game

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

links
boolean

Specifies whether to include links in the response.

header Parameters
Accept-Language
string

The language to use for the response.

Request Body schema: application/json
required

The request body

One of
GamePlayPlayWithOption (object) or GamePlayPlayWithoutOption (object) (GamePlayPlay)
object (GamePlayPartner)
object (GamePlayPlayer)

Responses

Request samples

Content type
application/json
Example
{
  • "play": {
    },
  • "partner": {
    },
  • "player": {
    }
}

Response samples

Content type
application/json
Example
{
  • "playInstruction": {
    },
  • "_links": [
    ]
}

Game Media

Game Media

Location Games

Location Games

Get games by the location id

Get games by the location id

Authorizations:
apiKeyaadOauth2
path Parameters
locationId
required
string

The id of the location

query Parameters
costToPlay.type
string

The type of cost to play (credit or cash)

icon.name
string

The variation of the icon to return (thumbnail, focus, etc.)

select
string
Example: select=id,name,description

A comma-separated list of fields to include in the response. If not specified, all fields are returned.

exclude
string
Example: exclude=id,name,description

A comma-separated list of fields to exclude from the response. If not specified, all fields are returned.

top
integer
Example: top=10

The maximum number of records to return in the response. If not specified, all records are returned.

skip
integer
Example: skip=10

The number of records to skip in the response. If not specified, no records are skipped.

orderBy
string
Example: orderBy=name desc

A comma-separated list of fields to order the response by. If not specified, the response is not ordered.

filter
string
Example: filter=name eq 'My Device'

A filter expression to apply to the response. If not specified, no filter is applied.

expand
string
Example: expand=device,users

A comma-separated list of fields to expand in the response. If not specified, no fields are expanded.

apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

links
boolean

Specifies whether to include links in the response.

header Parameters
Accept-Language
string

The language to use for the response.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "_links": [
    ]
}