General Purpose
This command are use to retrieve individual attractions with price, it'll show breakdown of session per attraction.
Price collected are final gross selling price inclusive of tax.
Request Parameter
Variable Name | Variable Type | Explain | Example |
|---|---|---|---|
dateOfSales | Date(YYYY-mm-dd) | Date of sales, by given which date of sales to collect available attraction with price defined by customer at EHORS system | 2020-03-17 |
Sample Request with JS
| Code Block | ||||
|---|---|---|---|---|
| ||||
$(document).ready(function(){
$.ajax({
url:"https://api.ehors.com",
method:'POST',
dataType:'xml',
data:{
accessID:'ABC123',
accessKey:'XYZ576abc',
moduleCode:'TicketSales',
command:'G_IND_Attractions',
dateOfSales:'2020-03-17'
},
success:function(response){
console.log(response);
}
})
}); |
Sample request with CURL
| Code Block |
|---|
curl -d "accessID=ABC123&accessKey=XYZ576abc&moduleCode=TicketSales&command=G_ATT_Planboard&dateOfSales=2020-03-17" -X POST https://api.ehors.com |
Respond XML Sample
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?>
<SCRIPT_RESULT>
<RESULT>
<ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="ALL STAR BIRDS SHOW" itemPrice="100.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB23" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="" itemPrice="" itemPrice_1="100.00" sessionID="CB31458" session="12:45 - 13:45" totalPrice="0.00" option_1="n" pass="1" max="1427" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="" itemPrice="" itemPrice_1="100.00" sessionID="CB31489" session="15:45 - 16:45" totalPrice="0.00" option_1="n" pass="1" max="1541" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="CB55" itemType="BDI" itemName="6R PHOTO" itemPrice="0.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="CB55" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="CB55" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="HBB32955" session="00:01 - 23:59" totalPrice="0.00" option_1="n" pass="1" max="29944" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="BB600" itemType="BDI" itemName="AUGMENTED REALITY" itemPrice="0.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB600" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB600" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="CB31520" session="00:00 - 23:59" totalPrice="0.00" option_1="n" pass="1" max="8000" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="BB600" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="HCC33159" session="24:01 - 24:02" totalPrice="0.00" option_1="n" pass="1" max="10000" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB25" itemType="BDI" itemName="BACK OF THE HOUSE" itemPrice="0.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB25" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB25" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="CB31582" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="2814" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="CB71" itemType="BDI" itemName="BALLPIT" itemPrice="0.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="CB71" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="CB71" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="HCC33520" session="00:01 - 23:59" totalPrice="0.00" option_1="n" pass="1" max="29931" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="CB13" itemType="BDI" itemName="BIRD HOUSE w/ BIRD FEEDING" itemPrice="0.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="CB13" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="CB13" itemType="BDI" itemName="" itemPrice="" itemPrice_1="0.00" sessionID="CB32095" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="9675" autoAssign="y"/>
... SUPPRESSED DATA ...
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="SHARKS AND RAYS AQUANAUT VOYAGE" itemPrice="1500.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB21" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32817" session="10:00 - 10:45" totalPrice="0.00" option_1="n" pass="1" max="4" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32848" session="12:00 - 12:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32879" session="13:00 - 13:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32910" session="14:00 - 14:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32941" session="15:00 - 15:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB32972" session="16:00 - 16:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB33003" session="17:00 - 17:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB21" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HCB33034" session="18:00 - 18:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB18" itemType="BDI" itemName="SHARKS AND RAYS DRY ENCOUNTER" itemPrice="300.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB18" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB18" itemType="BDI" itemName="" itemPrice="" itemPrice_1="300.00" sessionID="CB31706" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="7675" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="BB20" itemType="BDI" itemName="SHARKS AND RAYS SWIM ENCOUNTER" itemPrice="1500.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB20" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB20" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HBB32897" session="10:15 - 11:00" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB20" itemType="BDI" itemName="" itemPrice="" itemPrice_1="1500.00" sessionID="HBB32927" session="14:45 - 15:30" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB218" itemType="BDI" itemName="BE A SEA LION TRAINER" itemPrice="3500.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB218" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB218" itemType="BDI" itemName="" itemPrice="" itemPrice_1="3500.00" sessionID="HCB32724" session="11:30 - 12:15" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB218" itemType="BDI" itemName="" itemPrice="" itemPrice_1="3500.00" sessionID="HCB32755" session="14:00 - 14:45" totalPrice="0.00" option_1="n" pass="1" max="4" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="BB218" itemType="BDI" itemName="" itemPrice="" itemPrice_1="3500.00" sessionID="HCB32786" session="15:00 - 15:45" totalPrice="0.00" option_1="n" pass="1" max="6" autoAssign="n"/>
<ATTRACTION_ITEMS itemID="CB70" itemType="BDI" itemName="SUPER TOY COLLECTION" itemPrice="150.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="CB70" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="CB70" itemType="BDI" itemName="" itemPrice="" itemPrice_1="150.00" sessionID="CB32157" session="00:01 - 23:59" totalPrice="0.00" option_1="n" pass="1" max="9035" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="BB12" itemType="BDI" itemName="SYMPHONY EVENING SHOW" itemPrice="250.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB12" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB12" itemType="BDI" itemName="" itemPrice="" itemPrice_1="250.00" sessionID="CB32126" session="17:45 - 19:00" totalPrice="0.00" option_1="n" pass="1" max="723" autoAssign="y"/>
<ATTRACTION_ITEMS itemID="BB11" itemType="BDI" itemName="TRAILS TO ANTARCTICA" itemPrice="250.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
<TAXES BDIID="BB11" taxServiceID="BB4" taxServiceType="vat" accountID="BB340" description="VAT Output" perc="12.00"/>
<ATTRACTION_ITEMS itemID="BB11" itemType="BDI" itemName="" itemPrice="" itemPrice_1="250.00" sessionID="CB31613" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="6993" autoAssign="y"/>
<PROPERTY_DISCOUNTS senDiscPerc="20.00" senDiscVatExem="y" pwdDiscPerc="20.00" pwdDiscVatExem="y"/>
<SPECIAL_VARIABLES totalBDICount="31"/>
<CONSTANTS mode="scheduled" countryID="52" outletID="BB37"/>
</RESULT>
<SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS>
</SCRIPT_RESULT>
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="utf-8"?>
<SCRIPT_RESULT>
<RESULT>
<PROPERTY_DISCOUNTS senDiscPerc="20.00" senDiscVatExem="y" pwdDiscPerc="20.00" pwdDiscVatExem="y"/>
<SPECIAL_VARIABLES totalBDICount="0"/>
<CONSTANTS mode="scheduled" countryID="52" outletID="BB37"/>
</RESULT>
<SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS>
</SCRIPT_RESULT>
|
XML Node Explain
Node | Importance | Explain | ||||||
|---|---|---|---|---|---|---|---|---|
#PROPERTY_DISCOUNT | Low | This node are use to provide system discount from EHORS, can be ignore | ||||||
#PROPERTY_DISCOUNT@senDiscPerc | Low | Senior citizen discount percentage setting from EHORS, can be ignore | ||||||
#PROPERTY_DISCOUNT@senDiscVatExem | Low | VAT Exemption setting from EHORS, cab be ignore | ||||||
#PROPERTY_DISCOUNT@pwdDiscPerc | Low | PWD discount percentage setting from EHORS, can be ignore | ||||||
#PROPERTY_DISCOUNT@pwdDiscVatExem | Low | PWD discount shall be VAT exempted setting from EHORS, can be ignore | ||||||
#SPECIAL_VARIABLES | Medium | This node use to contain some additional info for the result, like summary | ||||||
#SPECIAL_VARIABLES@totalBDICount | Medium | Number of attractions found, can use to make looping count on attractions nodes | ||||||
#CONSTANTS | Low | This node use to show additional settings from EHORS, can be ignore | ||||||
#CONSTANTS@mode | Low | System mode for ticket sales program, can be ignore | ||||||
#CONSTANTS@countryID | Low | Country ID use for ticket sales program, can be ignore | ||||||
#CONSTANTS@outletID | Low | Outlet ID use for ticket sales program, needed later to confirm a sales | ||||||
#ATTRACTION_ITEMS | High | Individual node for attraction, can be either attraction info or session details. Its a combinations use for attraction and session. If sessionID is blank, its an attraction, else its session mapped with itemID | ||||||
#ATTRACTION_ITEMS@itemID | High | Unique ID of the attraction, this case it alias as BDIID or as attractionID, its use to map same #ATTRACTION_ITEMS node to map between attraction and session node | ||||||
#ATTRACTION_ITEMS@itemType | Low | Use by EHORS ticket sales program, can be ignore. It'll be fixed at "BDI" at the moment unless changes in future | ||||||
#ATTRACTION_ITEMS@itemName | High | If not blank it'll indicate this node is an attractions and will be given a name of the attraction define by user | ||||||
| High | If blank indicated this node is session node, else if not blank its an attraction general price and use for EHORS ticket sales program, can be ignore | ||||||
#ATTRACTION_ITEMS@itemPrice_1 | Low | This attribute only valid on session node. It use for item price of the attraction' session, different session may have different price. The amount of price are in double precision, no thousand separator and amount are final selling amount inclusive tax. This will be the price linked with the sessionID / planBoardID. The amount should be same as its "parent" XML node with same itemID, thus its use for "display", can be ignore if not use. | ||||||
#ATTRACTION_ITEMS@sessionID | High | Only valid for session node, attraction node will be blank. Unique ID of the session, each attraction may have more than 1 (one) session, this IS also may call or use as planBoardID | ||||||
#ATTRACTION_ITEMS@session | High | Session in STRING format combined start time and end time of the session, may refer to [ G_ATT_Planboard ] Get Plan Board Availability for session time start and time end as well as session hosting venue | ||||||
#ATTRACTION_ITEMS@totalPrice | Low | Use by EHORS ticket sales program to calculate number of pax multiply by itemPrice_1 for the session, and sum for sessions selected for attraction node, can be ignore | ||||||
#ATTRACTION_ITEMS@option_1 | Low | Use by EHORS ticket sales program to indicate if the session been selected, can be ignore | ||||||
#ATTRACTION_ITEMS@pass | Low | Use by EHORS ticket sales program to make check sum of the validation of data, can be ignore | ||||||
#ATTRACTION_ITEMS@max | Medium | If Blank indicated attraction node. Maximum pax can be selected for this session, use by EHORS ticket sales program, can be ignore | ||||||
#ATTRACTION_ITEMS@autoAsign | Low | Use by EHORS ticket sales program to auto select in the program, absolutes feature, can be ignore | ||||||
#TAXES | Medium | Taxes element node mapped with BDIID which if #ATTRACTION_ITEMS@itemID same, mean this taxes node are belonging to the mapped attraction, each attraction can have more than 1 tax node | ||||||
#TAXES@BDIID | Medium | Unique ID that use to map with #ATTRACTION_ITEMS@itemID to show the linkage between the attraction and #TAXES node | ||||||
#TAXES@taxServiceID | Low | Unique ID from EHORS system for the tax, can be ignore | ||||||
#TAXES@taxServiceType | Medium | Tax type of the node, can be vat / gt / sc, can be ignore | ||||||
#TAXES@accountID | Medium | Unique ID from EHORS system that the tax charges will goes to which account ID, can be ignore | ||||||
#TAXES@description | Medium | Tax description, human readable text in STRING format define by customer for the tax | ||||||
#TAXES@perc | Medium | Percentage use of the tax over the final attraction' session sales amount |
Sample availability in EHORS system
