Get table by id

GET 
/api/v2/tables/:table_id

Retrieve a table by its id

Request

Path Parameters

table_id stringrequired

Responses

200

application/json

Schema

Schema

id uuidrequired

Unique ID of the table

floor_plan_id uuidnullable

ID of the floor plan that the table belongs to

number stringrequired

Human-friendly identifier of the table

number_of_seats integerrequired

Number of seats the table has

position_x numberrequired

X position of the table in the floor plan

position_y numberrequired

Y position of the table in the floor plan

rotation numberrequired

Rotation of the table in the floor plan

shape stringrequired

Possible values: [round, square, rectangular]

Shape of the table in the floor plan

Example (from schema)

{
  "id": "120c50ab-24ae-48f9-8860-ec0e9adea9ec",
  "floor_plan_id": "762031eb-9c0f-4b22-919e-514b50f9613e",
  "number": "Table 1",
  "number_of_seats": 4,
  "position_x": 100,
  "position_y": 100,
  "rotation": 0,
  "shape": "round"
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...