Versions Compared

Version Old Version 8 New Version 9
Changes made by

Martin Mahony

Martin Mahony

Saved on

Key

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

...

Element

Type

Description

siteIDList

Array

If provided, results will only be returned for the properties specified. If not provided, all properties enabled for your API user will be returned.

channelIDList

Array

If provided, and therateInformation option is set, only rates mapped to one or more of the specified channels are returned. If not provided, the default website channel is assumed. List of Channels

options

Array

Specify one or more of the available options to determine what information is returned in the response. List of Options

...

Code Block
languagejson
{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getPropertyInformation",
    "siteIDList": [
        1853
    ],
    "channelIDList": [
    ],
    "options": [
        "fullPropertyInformation",
        "rateInformation".
        "roomInformation",
        "rateGroupInformation",
        "taxPolicyInformation",
        "imageInformation"
    ]
}

Channels

Channel

UAT ID

Production ID

My Site

19

7

Facebook

21

9

Facebook Like

22

10

CRO

26

11

SiteMinder

27

12

GNHUniverse

51

81

Options

Option

Description

fullPropertyInformation

Property information including name, address, geolocation, facilities and other property configuration options.

rateInformation

List of rates available on that property. Only rates on the specified channel are returned.

roomInformation

List of rooms available on that property.

rateGroupInformation

List of rate groups available on that property. Only rate groups with rates that are availabile on the channel specified are returned.

taxPolicyInformation

List of tax policies configured for that property. Where a rate has a specific tax policy selected, the taxPolicyID will be included in the rate information Any rate that has a NULL taxPolicyID indicates pricing inclusive of all taxes and charges.

imageInformation

Where you require the fully-resolved URLs for all property, rate or room imagery, this option must be included. This option adds a small performance overhead and should be used only if required.

Channels

Channel

UAT ID

Production ID

My Site

19

7

Facebook

21

9

Facebook Like

22

10

CRO

26

11

SiteMinder

27

12

GNHUniverse

51

81

Response

Sample

Code Block
languagejson
{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "address": "Avvio House, Lonsdale Road, National Technology Park, Castletroy, Co. Limerick V94 AW2X",
      "phone": "+353-61-335680",
      "fax": "",
      "url": "http://www.shrgroup.com",
      "stars": 4,
      "currency": "EUR",
      "portalShort": false,
      "notificationEmail": "martin.mahony@shrgroup.com",
      "acceptedCards": [
        "VISA",
        "MC",
        "AMEX"
      ],
      "timezone": "Europe/Dublin",
      "earliestETA": "12:00",
      "latestETA": "23:30",
      "cutoffTime": "23:30",
      "facilities": [
        "01",
        "11",
        "14",
        "21",
        "24"
      ],
      "images": [
        3160
      ],
      "childPriceOptions": [
        {
          "ageGroup": "child1",
          "label": "ch1",
          "minAge": 2,
          "maxAge": 5
        },
        {
          "ageGroup": "child2",
          "label": "ch2",
          "minAge": 6,
          "maxAge": 10
        },
        {
          "ageGroup": "child3",
          "label": "ch3",
          "minAge": 11,
          "maxAge": 15
        },
        {
          "ageGroup": "child4",
          "label": "ch4",
          "minAge": 16,
          "maxAge": 21
        },
        {
          "ageGroup": "infant",
          "label": "inf",
          "minAge": 0,
          "maxAge": 2
        }
      ],
      "portalURL": "https://dev.avvio.com/convert/site/TestHotel Mahony[@PORTALTOKEN@]/",
      "platformURL": {
        "bookingEngineURL": "https://dev.avvio.com/convert/site/TestHotel Mahony/",
        "bookingEngineGuestURL": "https://dev.avvio.com/convert/site/TestHotel Mahony/guests.php?checkin=@CHECKIN@&nights=@NIGHTS@&rateID=@RATEID@&roomIDs=@ROOMIDS@&availability=5ufo6wrHHjOm_c_5SmTMNwPOzPymyxK3hR_wvQUFK61zIODWM-Gg0I16pZ2ywyQ9va9qYN7R-W-YBQLeD6BShg"
      }
    }
  ]
}