Get a seating level by id

GET 
/seating/:id

Get a seating level by id

Request

Path Parameters

id stringrequired

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

id stringrequired

The id for the seating level

parentId stringrequired

The parent of the seating level

name stringrequired

The name of the seating level

tags objectrequired

The tags of the seating level

isRoot booleanrequired

If true the seating level is a root level with no parents

kiosks string[]required

The Kiosks accessible from the seating level

parents object[]required
The parent levels of the seating level
Array [
parentLevel integerrequired
The level of the parent between the child and root levels
]
childCount integerrequired

The count of children this level has

depth integerrequired

The depth of the seating level in the hierarchy

hasChildren booleanrequired

If true the seating level has children

Example (from schema)

{
  "parents": [
    {
      "parentLevel": 0,
      "id": "string",
      "parentId": "string",
      "name": "string",
      "tags": {},
      "isRoot": true,
      "kiosks": [
        "string"
      ]
    }
  ],
  "childCount": 0,
  "depth": 0,
  "hasChildren": true,
  "id": "string",
  "parentId": "string",
  "name": "string",
  "tags": {},
  "isRoot": true,
  "kiosks": [
    "string"
  ]
}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Bad request]

A short, human-readable summary of the problem type.

status number

Possible values: [400]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

errors objectrequired
property name* object

Example (from schema)

{
  "type": "string",
  "title": "Bad request",
  "status": 400,
  "detail": "string",
  "instance": "string",
  "errors": {}
}

401

Access is unauthorized.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Unauthorized]

A short, human-readable summary of the problem type.

status number

Possible values: [401]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Unauthorized",
  "status": 401,
  "detail": "string",
  "instance": "string"
}

404

The server cannot find the requested resource.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Not Found]

A short, human-readable summary of the problem type.

status number

Possible values: [404]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Not Found",
  "status": 404,
  "detail": "string",
  "instance": "string"
}

Loading...