Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
GET v3/categories


Request URL Parameters

ParameterDescription

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

limit
integer
optional, default is 25


The maximum number of categories to return, up to 50.


Retrieve Specific Categories

...

Code Block
GET v3/categories/:category_id


Request URL Parameters

ParameterDescription
id
integer
required

The category id

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

Requests

Retrieve All Requests

...

Code Block
GET v3/requests


Request URL Parameters

ParameterDescription

hotel_id
integer
required

Property Numerical identifier 
Cannot be null

limit
integer
optional, default is 25


The maximum number of requests to return, up to 50.
offset
integer
optional, default is 0

The number of requests to skip over, where the ordering is consistent but unspecified.


Retrieve Single Request

This call returns a specific request for property.

...

Code Block
GET v3/requests/:request_id


Request URL Parameters

ParameterDescription

id
integer
required


The request id

hotel_id
integer
required


Property Numerical identifier 
Cannot be null


Create a Request

This call creates a new request and returns a request object.

Code Block
POST v3/requests


Request URL Parameters

ParameterDescription

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

Guest
array of strings
required


see list of supported strings













Anchor
Guest Array
Guest Array

ParameterDescription

name
string
required


Guest fullname i.e. "John Doe"

email
string
required


guest email
phone
string
required

guests preferred phone number


return [
'hotel_id' => 'required|integer',
'guest.name' => 'required|string',
'guest.phone' => ['required_without:guest.email', new PhoneNumber],
'form_name' => 'required|string',
'guest.email' => 'required|string|email',
'guest_notify' => 'required|boolean',
'form_category' => 'required|string',
'staff_username' => 'sometimes|required|string',
'status' => 'sometimes|required|in:New,Processing,Completed,Cancelled',
'form_fields' => 'required|array',
'form_fields.details' => 'sometimes|required|string|min:10,max:20000'
];

...