Versions Compared

Old Version 10

changes.mady.by.user Jesse Chieppa

Saved on

compared with

New Version 11

changes.mady.by.user Jesse Chieppa

Saved on

Key

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

...

Code Block
{
    "api_version": 3,
    "status": "failed",
    "errors": {
        "code": 429,
        "message": "Too many requests",
        "retry-after": "2020-02-11T02:44:47+00:00"
    },
    "request_uuid": "b84ecfde-19de-4ede-a96a-91f86c623841"
}


Validation:


Technical Support

To assist our partners' integration to our API platform,  please use our support system at our Online Support Portal.  Every API call response contains meta information including the status of the response, api version and the request_uuid.  When requesting technical support please provide the endpoint you are making the call to, your formatted request and the full response from the api including the request_uuid.

Sample Success meta information:

Code Block
    "api_version": 3,
    "status": "success",
    "request_uuid": "35f52462-a3e6-4a37-aaed-c7326932fb3a"

Sample Error meta information:

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

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

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.

Fetch a Properties forms as Form Object array.

Code Block
GET  v3/forms


Request URL Parameters

ParameterDescription

hotel_id
integer
required

Property Numerical identifier 
Cannot be null

limit
integer
optional, default is 25


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

...

This call returns a specific form and the form fields associated for the requested.  

Fetch a Properties forms specific form as Form Object array.


Code Block
GET  v3/forms/:form_id

Request URL Parameters

ParameterDescription

hotel_id
integer
required


Property Numerical identifier Cannot be null

hotel_id
integer
required
Form Numerical identifier from the Retrieve All Forms call.

limit
integer
optional, default is 25


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


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.

Fetch a Properties staff as Staff Object array.

Code Block
GET  v3/staff


Request URL Parameters

ParameterDescription

hotel_id
integer
required

Property Numerical identifier 
Cannot be null

Retrieve Specific 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.

Fetch a Properties staff as Staff Object array.

Code Block
GET  v3/staff/:username


Request URL Parameters

ParameterDescription

hotel_id
integer
required


Property Numerical identifier 
Cannot be null
username
string
required
Specific staff username obtained from the retrieve all staff call
ParameterDescription

room
string
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.
Cannot be null

details
string
required

Details 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


Message Structure

Create Request

...