...
| Code Block |
|---|
{
"api_version": 3,
"status": "failed",
"errors": {
"status": 404,
"title": "record not found",
"details": "no record 345 found"
},
"request_uuid": "b0370ef0-3c83-40af-a993-0201f37c33dc"
} |
Endpoints
Properties
| Anchor | ||||
|---|---|---|---|---|
|
Retrieve All Properties
This call returns all of a properties that have authorized the provider access via the API. Properties are returned in a paginated collection which provides a Meta Array with pagination information.
Fetch all Properties as Properties Object array.
...
Forms
| Anchor | ||||
|---|---|---|---|---|
|
Retrieve All Forms
This call returns all of a properties forms and the fields associated with each form. Forms are returned in a paginated collection which provides a Meta Array with pagination information.
...
| Code Block |
|---|
POST v3/requests |
Request URL Parameters
...
| Parameter | Description |
|---|---|
hotel_id | Property Numerical identifier Cannot be null |
Guest | see list of supported strings |
Guest Array
...
| Category |
string required |
email
string
required
string
required
...
form category name from the categories api | |
'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,
validator
return [
'hotel_id' => 'required|integer',
...
...
=>
...
'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'
];
Guest Array
| Anchor | ||||
|---|---|---|---|---|
|
| Parameter | Description |
|---|---|
name | Guest fullname i.e. "John Doe" |
email | guest email |
| phone string required | guests preferred phone number |
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"
}
} |
...