Create a reservation of a business

POST 
/api/v1/reservations

Create a reservation of a business

Request

application/vnd.api+json

Body

required

data

object

type stringrequired

Possible values: [reservations]

attributes

object

name stringrequired

date daterequired

from int32required

to int32required

party_size int32required

email stringrequired

marketing_agreement boolean

Possible values: [true, false]

phone string

phone_country_code string

phone_country_prefix string

guest_id string

tables

object[]

Array [

id stringrequired

seats_taken int32required

]

comment string

relationships

object

business

object

data

object

type stringrequired

Possible values: [business]

id stringrequired

Related Business ID

user

object

data

object

type string

Possible values: [user]

id string

Related User ID

Responses

201

Create a reservation of a business

application/vnd.api+json

Schema

Schema

data

object

id stringrequired

type stringrequired

Possible values: [reservations]

links

object

required

self stringrequired

attributes

object

required

comment stringnullablerequired

date stringrequired

email stringnullablerequired

from numberrequired

marketing-agreement boolean

name stringrequired

other-rejection-reason stringnullablerequired

party-size numberrequired

phone stringnullablerequired

phone-country-code stringnullablerequired

phone-country-prefix stringnullablerequired

reject-reason stringnullablerequired

state string

status string

table

object

nullable

required

id numberrequired

business_id stringrequired

floor_plan_id string

number stringrequired

number_of_seats numberrequired

uuid stringrequired

shape stringrequired

rotation numberrequired

position_x numberrequired

position_y numberrequired

guest-id string

to numberrequired

created-at stringrequired

relationships

object

required

bookings

object

required

data

object[]

required

Array [

type stringrequired

Possible values: [bookings]

id stringrequired

]

tables

object

required

links

object

required

self stringrequired

related stringrequired

business

object

required

links

object

required

self stringrequired

related stringrequired

user

object

required

links

object

required

self stringrequired

related stringrequired

meta

object

total-count numberrequired

total-pages numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "reservations",
    "links": {
      "self": "string"
    },
    "attributes": {
      "comment": "string",
      "date": "string",
      "email": "string",
      "from": 0,
      "marketing-agreement": true,
      "name": "string",
      "other-rejection-reason": "string",
      "party-size": 0,
      "phone": "string",
      "phone-country-code": "string",
      "phone-country-prefix": "string",
      "reject-reason": "string",
      "state": "string",
      "status": "string",
      "table": {
        "id": 0,
        "business_id": "string",
        "floor_plan_id": "string",
        "number": "string",
        "number_of_seats": 0,
        "uuid": "string",
        "shape": "string",
        "rotation": 0,
        "position_x": 0,
        "position_y": 0
      },
      "guest-id": "string",
      "to": 0,
      "created-at": "string"
    },
    "relationships": {
      "bookings": {
        "data": [
          {
            "type": "bookings",
            "id": "string"
          }
        ]
      },
      "tables": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "business": {
        "links": {
          "self": "string",
          "related": "string"
        }
      },
      "user": {
        "links": {
          "self": "string",
          "related": "string"
        }
      }
    }
  },
  "meta": {
    "total-count": 0,
    "total-pages": 0
  }
}

Loading...