Overview
Request
Element | Type | Description |
|---|---|---|
siteIDList | Array | (Mandatory) A list of property IDs for which voucher information should be returned. This must be a subset of properties that are enabled for your API. |
options | Specify one or more of the available options to determine what information is returned in the response. List of Options |
Sample
{
"userAuth": {
"username": "username",
"password": "password"
},
"operation": "getVoucherInformation",
"siteIDList": [
1853
],
"options": [
"fullPropertyInformation",
"voucherInformation",
"ticketInformation",
"imageInformation"
]
}
Options
Option | Type | Description |
|---|---|---|
fullPropertyInformation | String | Property information including name, address, geolocation, facilities and other property configuration options. |
voucherInformation | String | Full voucher including title, description, images pricing and URL. |
ticketInformation | String | Full ticket information including title, description, images and URL. |
imageInformation | String | If this option is specified in conjunction with the voucherInformation or ticketInformation options, full image information will be returned in the response. |
Response
Sample
{
"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",
"email": "martin.mahony@shrgroup.com",
"voucherList": [
{
"title": "Test Voucher",
"description": "this is a test voucher",
"category": "",
"images": [
{
"groupID": 3381,
"size": "120x90",
"url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/120x90.jpg"
},
{
"groupID": 3381,
"size": "400x300",
"url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/400x300.jpg"
},
{
"groupID": 3381,
"size": "800x600",
"url": "d1ge8a3d73odmf.cloudfront.net/053/026/000/3381/800x600.jpg"
}
],
"prices": [
{
"type": "perPersonValue",
"minValue": 250,
"maxValue": 250,
"stepValue": 0,
"strikeValue": 0,
"totalQuantity": 78,
"totalQuantitySold": 38,
"startSell": "2000-01-01",
"endSell": "2999-12-31",
"maxPerSale": 0
}
],
"url": "https://dev.avvio.com/vouchers/site/TestHotel%20Mahony/en/index/voucher/8796093022466.html"
}
],
"ticketList": [
{
"title": "Test Ticket",
"description": "this is a test ticket",
"images": [
{
"groupID": 1711,
"size": "120x90",
"url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/120x90.jpg"
},
{
"groupID": 1711,
"size": "400x300",
"url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/400x300.jpg"
},
{
"groupID": 1711,
"size": "800x600",
"url": "d1ge8a3d73odmf.cloudfront.net/047/013/000/1711/800x600.jpg"
},
{
"groupID": 3295,
"size": "120x90",
"url": "d1ge8a3d73odmf.cloudfront.net/095/025/000/3295/120x90.png"
},
{
"groupID": 3295,
"size": "400x300",
"url": "d1ge8a3d73odmf.cloudfront.net/095/025/000/3295/400x300.png"
}
],
"prices": [
{
"type": "fixedValue",
"minValue": 300,
"maxValue": 300,
"stepValue": 0,
"strikeValue": 0,
"totalQuantity": null,
"totalQuantitySold": null,
"startSell": "2000-01-01",
"endSell": "2999-12-31",
"maxPerSale": 0,
"tiers": [
{
"titleShort": "Standing",
"titleLong": "Standing Ticket",
"description": "The standing section is our cheapest option",
"unitValue": 49,
"strikeValue": 0,
"totalQuantity": 15,
"totalQuantitySold": 0,
"maxPerSale": 4,
"startSell": null,
"endSell": null
},
{
"titleShort": "General",
"titleLong": "General Seating",
"description": "The public seating section is our mid-range option",
"unitValue": 65,
"strikeValue": 0,
"totalQuantity": 20,
"totalQuantitySold": 1,
"maxPerSale": 4,
"startSell": null,
"endSell": null
},
{
"titleShort": "Private",
"titleLong": "Private Seating",
"description": "The private seating section is our most expensive option",
"unitValue": 80,
"strikeValue": 0,
"totalQuantity": 20,
"totalQuantitySold": 0,
"maxPerSale": 4,
"startSell": null,
"endSell": null
}
]
}
],
"url": "https://dev.avvio.com/vouchers/site/TestHotel%20Mahony/en/index/voucher/8796093022470.html"
}
]
}
]
}