Page History

...

Request URL Parameters

hotel_Property Numerical identifier Cannot be nullForm Numerical identifier from the Retrieve All Forms call.The maximum number of forms to return, up to 50.

Parameter	Description
id integer required		The id of the form
hotel_id integer required	limit integer optional, default is 25	Property Numerical identifier Cannot be null

Staff

Retrieve All Staff

This call returns all available staff by property and their roles. Forms are returned in a paginated collection which provides a Meta Array with pagination information.

...

Code Block
GET v3/staff

Request URL Parameters

Parameter	Description
hotel_id integer required	Property Numerical identifier Cannot be null

Retrieve Specific Staff

This call returns all available staff by property and their roles.

Fetch a Properties staff as Staff Object array.

Code Block
GET v3/staff/:username

Request URL Parameters

Parameter	Description
username string required	Specific staff username obtained from the retrieve all staff call
hotel_id integer required	Property Numerical identifier Cannot be null

Message Structure

Create Request

Code Block
POST v2/requests/create/{hotelid}

integer
optional, default is 25

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

Retrieve Specific Categories

This call returns all available form categories including their respective department.

Fetch a Properties categories as categories Object array.

Code Block
GET v3/categories/:category_id

Request URL ParametersRequest Body Parameters within

Parameter	Description

room

id

string

integer
required

Room number assigned to the booking without the siteid.
Cannot be null

booking_id
string
required

Primary Booking ID for the request, omitting the siteid.

The category id
hotel_id integer required	Property Numerical identifier Cannot be null

Requests

Retrieve All Requests

This call returns all requests for property and their roles. Requests are returned in a paginated collection which provides a Meta Array with pagination information.

Fetch a Properties requests as request Object array.

Code Block
GET v3/requests

Request URL Parameters

Parameter	Description
hotel_id integer required	Property Numerical identifier Cannot be null

details

limit

string
requiredDetails of the request. 2000 characters maximum.

email
string
required

Guest Email . This is the primary key that will be used to match
an existing guest or create a new guest in MyGuests

name
string
required

Guest Name

phone
string
required

Guest Primary Phone. Recommended to default to mobile number
to support eventual SMS functionality

rewards_number
string
optional

Optional field for supporting a hotels rewards or loyalty program. Can be sent as null or omitted if not used.

message_channel
string
optional

Used when created a Request related to a messaging API.
Optional field which can be sent as null or omitted if not used.
String should match the name of the related OTA Channel i.e. "BookingCenter" or "Booking.com" .
If used message_thread element is required.

message_thread
string
optionalUsed when created a Request related to a messaging API.
Optional field which can be sent as null or omitted if not used.
String should match the thread id provided by the OTA for the messaging thread.
If used `message_channel` element is required.

guest_notify
boolean
required

Boolean to determine if we send an email to the guest on new request
creation. Accepted values false or true

form_name
string
required

One of "Self Checkin" , "E-Sign" case insensitive. Mappedto form name
and category in MyGuests. If not found a new form will be created

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.

Fetch a Properties request as request Object array.

Code Block
GET v3/requests/:request_id

Request URL Parameters

Parameter	Description
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

Parameter	Description
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

Parameter	Description
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'
];

Example Request

Code Block

{
  "request": {
    "room": "32",
    "booking_id": "1332025-4X",
    "details": "credit card declined",
    "email": "jchieppa@gmail.com",
    "name": "Joe Banks",
    "phone": "7075551414",
    "rewards_number": null,
	"message_channel": "BookingCenter",
    "message_thread": "597470647",
    "guest_notify": false,
    "form_name": "Self Checkin"
  }
}

...

Page tree

Versions Compared

Old Version 11

New Version 12

Key

Staff

Retrieve All Staff

Retrieve Specific Staff

Categories

Retrieve All Categories

Message Structure

Create Request

Retrieve Specific Categories

Requests

Retrieve All Requests

Retrieve Single Request

Create a Request

Example Request