...
| Code Block |
|---|
GET v3/properties |
Request URL Parameters
| Parameter | Description |
|---|---|
hotel_id | Property Numerical identifier Cannot be null |
Example Response
| Code Block |
|---|
{
"properties": [
{
"id": 2,
"name": "A MyPMS Demo Hotel",
"site_url": "http://Hotel.bookingcenter.com",
"timezone": "America/Dawson",
"contact_email": "mypms@demohotel.com"
},
{
"id": 3,
"name": "Steves Test Property",
"site_url": "http://Hotel.bookingcenter.com",
"timezone": "Africa/Abidjan",
"contact_email": null
},
{
"id": 10,
"name": "Lava Ridges Test Property",
"site_url": "www.lavaridge.org",
"timezone": "America/Dawson",
"contact_email": "lavaridges@email.com"
}
],
"api_version": 3,
"status": "success",
"request_uuid": "74ec482c-5a37-416b-820e-0c0e52f0a6e7"
} |
...
| Code Block |
|---|
GET v3/properties/:id |
Request URL Parameters
| Parameter | Description |
|---|---|
id | The id of the property being retrieved |
Forms
| Anchor | ||||
|---|---|---|---|---|
|
Retrieve All Forms
...
| Parameter | Description |
|---|---|
hotel_id | Property Numerical identifier Cannot be null |
limit | 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. |
| status string optional, default is 0 | Filter Requests that match a specific status. Use Unresolved to retrieve all requests that have any status other than completed or cancelled. |
Retrieve Single Request
This call returns a specific request for property.
...
| Parameter | Description |
|---|---|
hotel_id | Property Numerical identifier Cannot be null |
Guest | 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 |
|
| status string optional default "New" |
|
| 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 |
...