General Purpose
This command are use to retrieve available package list from EHORS system define by customer by providing date of sales.
One package can have 1 or more BDI or attractions sales, this command are ONLY use to list general package information, for package detail please refer to [ G_PKG_Details ] Get Package Details
ONLY packages are with condition market segment "Internet" and segment source "Direct" will be fetch from EHORS
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 package(s) list defined by customer at EHORS system with market segment "Internet" and segment source "Direct" | 2021-11-23 |
Sample Request with JS
$(document).ready(function(){ $.ajax({ url:"https://api.ehors.com", method:'POST', dataType:'xml', data:{ accessID:'ABC123', accessKey:'XYZ576abc', moduleCode:'TicketSales', command:'G_ATT_Package', dateOfSales:'2021-11-23' }, success:function(response){ console.log(response); } }) });
Respond XML Sample
Success XML Sample
<?xml version="1.0" encoding="utf-8"?> <SCRIPT_RESULT> <RESULT> <PACKAGES packageID="BB5548" packageName="H2O - CORP OCEANS 5 (IN-HOUSE GUEST)" BDIIDs="BB11|BB12|BB10|BB600" packageSummary="------------------------ PACKAGE ITEMS ------------------------ 1 - TRAILS TO ANTARCTICA 2 - SYMPHONY EVENING SHOW 3 - OCEANARIUM 4 - AR|AUGMENTED REALITY p500 fy2019 ------------------------ Total Value / pax = 500.00"/> ... SUPPRESSED DATA ... <PACKAGES packageID="BB5549" packageName="H2O - SEA BREEZE EXPRESS 12 (IN-HOUSE GUEST)" BDIIDs="BB12|CB70|BB17|BB16|BB10|CB49|BB13|BB514|CB11|CB13|BB25|BB23" packageSummary="------------------------ PACKAGE ITEMS ------------------------ 1 - SYMPHONY EVENING SHOW 2 - STC|SUPER TOY COLLECTION 3 - SEA LION SHOW 4 - PENGUIN TALK SHOW 5 - OCEANARIUM 6 - NEONC|NEON CARS 7 - FISH SPA 8 - CREEPY CRAWLIES 9 - BY|BARNYARD 10 - BHF|BIRD HOUSE w/ BIRD FEEDING 11 - BACK OF THE HOUSE 12 - ALL STAR BIRDS SHOW p720 fy2018 ------------------------ Total Value / pax = 720.00"/> </RESULT> <SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS> </SCRIPT_RESULT>
Sample NO package available
<?xml version="1.0" encoding="utf-8"?> <SCRIPT_RESULT> <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, can be ignore |
#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 |
#ATTRACTION_ITEMS@itemPrice | Low | 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 | High | 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 |
#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 |