Versions Compared

Key

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

...

ParameterDescription
id
integer
required

The id of the form

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

...



Staff 
Anchor
staff
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.

...

ParameterDescription
username
string
required

Specific staff username obtained from the retrieve all staff call

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

...


Categories 
Anchor
categories
categories

Retrieve All Categories

This call returns all available form categories including their respective department.  Categories are returned in a paginated collection which provides a Meta Array with pagination information.

...

ParameterDescription
id
integer
required

The category id

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

...

Requests 
Anchor
requests
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.

...

ParameterDescription

hotel_id
integer
required


Property Numerical identifier 
Cannot be null

Guest
array of strings
required


see list of supported strings
Category
string
required

form category name from the categories apiendpoint











'guest_id' => $guest->id,
'category_id' => $form->category_id,
'property_id' => $form->property_id,
'room' => $request->input('room') ?? 'none',
'booking_id' => $request->input('booking_id') ?? null,
'message_channel' => $request->input('message_channel') ?? null,
'message_thread' => $request->input('message_thread') ?? null,
'first_time' => $guest->isFirstTime(),
'status_id' => 1,

...