Versions Compared

Key

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

...

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.

Retrieve Single

...

Form 
Anchor
singleform
singleform

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

...

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 endpoint
room
string
optional

Guest room for their booking
booking_id
string
optional

The reservation identifier for the guests stay with the property, if applicable.
guest_notify
boolean
required

Should an email be sent to the guest notifying them of this requests creation?  Recommended false
staff_username
string
optional


Staff Username from the staff endpoint if provided the newly created request will be assigned to this staffer.

form_name
string
required

Name of the form we are creating this request for from the forms endpoint
form_fields
array
required

details of the form request.  Needs to match any required form_fields for the specified form_name from the forms forms endpoint




Requests Guest Array

...

Example Request

Code Block
{
  "requesthotel_id": {2,
    "room": "32",
    "booking_id": "1332025-4X",
    "detailsguest": "credit card declined",{
    "email": "jchieppa@gmailjoeb@banks.com",
    "name": "Joe Banks",
    "phone": "7075551414",
  },
  "rewardsguest_numbernotify": nullfalse,
	  "messageform_channelcategory": "BookingCenterTreatment",
    "messageform_threadname": "597470647Spa Menu",
    "guestform_notifyfields": false,{
    "form_name	"Notes": "Self Checkin"
  }
}

Example Response

Code Block
{
    "api_version": "2"We'd like hot towels and a room to meditate in",
	"swedish1": 2,
    "statuspregnancy2": 1
  }
}

Example Response

Code Block
{"Success",
    "requests": {
        "id": 308878,
        "roombooking_id": "321332025-4X",
        "detailsroom": null"32",
        "property_idguest": 2,{
         "status_id   "name": "Joe 1Banks",
            "created_atemail": "2019-01-14 23:26:21joeb@banks.com",
            "updatedphone_atnumber": "2019-01-14 23:26:21",7075551414"
        "category_id": 21,
},
        "completedcreated_at": null"2020-02-12 15:43:15",
        "firstupdated_timeat": 1"2020-02-12 15:43:15",
        "stafflength_idopen": null"1 second",
        "guest_idstatus": 13,
        "booking_id": "1332025-4X",
		"message_channel": "BookingCenter",
		"message_thread": "597470647",
"New",
        "assigned": null,
        "statuscategory": {
            "id": 18,
            "name": "NewTreatment",
        },
        "createdrequest_atdetails": "2014-11-14 02:23:46",[
            "updated_at": "2014-11-14 02:23:46"{
        },
        "guestname": {
"Notes",
                "idvalue": 13,
            "name": "Joe Banks",
"We'd like hot towels and a room to meditate in",
                "emailamount": "jchieppa@gmail.com"null,
                "phonetype": "7075551414text",
            "rewards_number": "0"},
            "created_at": "2018-02-07 10:49:28",
{
                "updated_atname": "2019-01-11 22:09:36"Swedish1",
        },
        "staffvalue": null"2",
                "categoryamount": {
"80",
                "idtype": 21,"amount"
            "name": "Self Checkin",
},
            {
   "department_id": 7,
            "created_atname": "2019-01-14 22:21:55Pregnancy2",
            "updated_at    "value": "2019-01-14 22:21:551",
                "identifieramount": "21140",
            }
     }
}"type": "amount"
            }
        ],
        "comments": {
            "guest_comments": [],
            "staff_notes": []
        }
    },
    "api_version": 3,
    "status": "success",
    "request_uuid": "a25a7d79-ba8a-40a3-92a6-02862f7a16c2"
}