Page tree

Versions Compared

Key

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

General Purpose

This command are use to retrieve

...

 individual attractions with price, compare to 

Request Parameter

Variable Name

Variable Type

Explain

Example

dateOfSalesDate(YYYY-mm-dd)Date of sales, by given which date of sales to collect available plan board defined by customer at EHORS system2020-03-17

Sample Request with JS

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

$(document).ready(function(){
    $.ajax({
        url:"https://api.ehors.com",
        method:'POST',
        dataType:'xml',
        data:{
            accessID:'ABC123',
            accessKey:'XYZ576abc',
            moduleCode:'TicketSales',
            command:'G_ATT_Planboard',
            dateOfSales:'2020-03-19'
        },
        success:function(response){
            console.log(response);
        }
    })
});

Respond XML Sample

...

Code Block

...

language

...

xml

...

title

...

Success XML Sample

...

linenumbers

...

true
<?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>


Sample NO plan board available

1
2
3
4
5
6
7
8
9

<?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

Node

Importance 

Explain

#PROPERTY_DISCOUNTLowThis node are use to provide system discount from EHORS, can be ignore
#PROPERTY_DISCOUNT@senDiscPercLowSenior citizen discount percentage setting from EHORS, can be ignore
#PROPERTY_DISCOUNT@senDiscVatExemLowVAT Exemption setting from EHORS, cab be ignore
#PROPERTY_DISCOUNT@pwdDiscPercLowPWD discount percentage setting from EHORS, can be ignore
#PROPERTY_DISCOUNT@pwdDiscVatExemLowPWD discount shall be VAT exempted setting from EHORS, can be ignore
#SPECIAL_VARIABLESMediumThis node use to contain some additional info for the result, like summary
#SPECIAL_VARIABLES@totalBDICountMediumNumber of attractions found, can use to make looping count on attractions nodes
#CONSTANTSLowThis node use to show additional settings from EHORS, can be ignore
#CONSTANTS@modeLowSystem mode for ticket sales program, can be ignore
#CONSTANTS@countryIDLowCountry ID use for ticket sales program, can be ignore
#CONSTANTS@outletIDLowOutlet ID use for ticket sales program, can be ignore
#PLANBOARD_ITEMSHighIndividual 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 attractionID
#PLANBOARD_ITEMS@attractionIDHighUnique alphanumeric attraction ID from EHORS to identify the attractions, it may also use as BDIID
#PLANBOARD_ITEMS@sessionIDHighUnique alphanumeric session ID from EHORS to identify the session within an attraction, it may also use as planBoardID
#PLANBOARD_ITEMS@attractionHighAttraction name define in EHORS system by customer, if data is blank identify as session element
#PLANBOARD_ITEMS@venueNameHighVenue name of the session hosted, define by customer in EHORS system, if data is blank identify as attraction element
#PLANBOARD_ITEMS@startTimeHighStart time in format of HH:mm of the session, if data is blank identify as attraction element
#PLANBOARD_ITEMS@endTimeHighEnd time in format of HH:mm of the session, if data is blank identify as attraction element
#PLANBOARD_ITEMS@paxHighMaximum capacity of the venue of the session can handle, if data is blank identify as attraction element
#PLANBOARD_ITEMS@reservedHighNumber of pax already reserved in EHORS system, if data is blank identify as attraction element
#PLANBOARD_ITEMS@availableHighSecurity check on maximum pax minus reserved, show directly the available left for this session, if data is blank identify as attraction element

Sample availability in EHORS system