...
Technical Support
To assist our partners' partner 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.
...
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.as Properties Object array.
| 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"
} |
Retrieve Single Property
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.
| Code Block |
|---|
GET v3/properties/:id |
Request URL Parameters
| Parameter | Description |
|---|---|
id | The id of the property being retrieved |
Forms
| Anchor | ||||
|---|---|---|---|---|
|
Retrieve All Forms
...
| Code Block |
|---|
{
"hotel_id": 2,
"room": "32",
"booking_id": "1332025-4X",
"guest": {
"email": "joeb@banks.com",
"name": "Joe Banks",
"phone": "7075551414"
},
"guest_notify": false,
"form_category": "Treatment",
"form_name": "Spa Menu",
"form_fields": {
"Notes": "We'd like hot towels and a room to meditate in",
"swedish1": 2,
"pregnancy2": 1
}
} |
Example Response
| Code Block |
|---|
{
"requests": {
"id": 878,
"booking_id": "1332025-4X",
"room": "32",
"guest": {
"name": "Joe Banks",
"email": "joeb@banks.com",
"phone_number": "7075551414"
},
"created_at": "2020-02-12 15:43:15",
"updated_at": "2020-02-12 15:43:15",
"length_open": "1 second",
"status": "New",
"assigned": null,
"category": {
"id": 8,
"name": "Treatment"
},
"request_details": [
{
"name": "Notes",
"value": "We'd like hot towels and a room to meditate in",
"amount": null,
"type": "text"
},
{
"name": "Swedish1",
"value": "2",
"amount": "80",
"type": "amount"
},
{
"name": "Pregnancy2",
"value": "1",
"amount": "140",
"type": "amount"
}
],
"comments": {
"guest_comments": [],
"staff_notes": []
}
},
"api_version": 3,
"status": "success",
"request_uuid": "a25a7d79-ba8a-40a3-92a6-02862f7a16c2"
}
|
...