You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
General Purpose
This command are use to retrieve plan board availability on each attraction along with its session.
It'll return the availability of each session along with the session time start and time end on which venue.
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 plan board defined by customer at EHORS system | 2020-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
Success XML Sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42 | <?xml version="1.0" encoding="utf-8"?>
<SCRIPT_RESULT>
<RESULT>
<PLANBOARD_ITEMS attractionID="BB23" sessionID="" attraction="ALL STAR BIRDS SHOW" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB23" sessionID="CB31457" attraction="" venueName="ALL STAR BIRD SHOW" startTime="12:45" endTime="13:45" pax="1600" reserved="232" available="1368"/>
<PLANBOARD_ITEMS attractionID="BB23" sessionID="CB31488" attraction="" venueName="ALL STAR BIRD SHOW" startTime="15:45" endTime="16:45" pax="1600" reserved="92" available="1508"/>
<PLANBOARD_ITEMS attractionID="CB55" sessionID="" attraction="6R PHOTO" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="CB55" sessionID="HBB32954" attraction="" venueName="OCEANARIUM" startTime="00:01" endTime="23:59" pax="30000" reserved="129" available="29871"/>
<PLANBOARD_ITEMS attractionID="BB600" sessionID="" attraction="AUGMENTED REALITY" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB600" sessionID="CB31519" attraction="" venueName="OCEANARIUM" startTime="00:00" endTime="23:59" pax="8000" reserved="0" available="8000"/>
<PLANBOARD_ITEMS attractionID="BB600" sessionID="HCC33158" attraction="" venueName="OCEANARIUM" startTime="24:01" endTime="24:02" pax="10000" reserved="0" available="10000"/>
... SUPPRESSED DATA ...
<PLANBOARD_ITEMS attractionID="BB21" sessionID="" attraction="SHARKS AND RAYS AQUANAUT VOYAGE" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32816" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="10:00" endTime="10:45" pax="6" reserved="6" available="0"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32847" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="12:00" endTime="12:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32878" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="13:00" endTime="13:45" pax="6" reserved="2" available="4"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32909" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="14:00" endTime="14:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32940" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="15:00" endTime="15:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB32971" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="16:00" endTime="16:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB33002" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="17:00" endTime="17:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB21" sessionID="HCB33033" attraction="" venueName="SHARKS AND RAY AQUANAUT VOYAGE" startTime="18:00" endTime="18:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB18" sessionID="" attraction="SHARKS AND RAYS DRY ENCOUNTER" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB18" sessionID="CB31705" attraction="" venueName="SHARK AND RAY DRY ENCOUNTER" startTime="06:00" endTime="20:00" pax="8000" reserved="77" available="7923"/>
<PLANBOARD_ITEMS attractionID="BB20" sessionID="" attraction="SHARKS AND RAYS SWIM ENCOUNTER" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB20" sessionID="HBB32896" attraction="" venueName="SHARKS AND RAY WHOLE BODY ENCOUNTER" startTime="10:15" endTime="11:00" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB20" sessionID="HBB32926" attraction="" venueName="SHARKS AND RAY WHOLE BODY ENCOUNTER" startTime="14:45" endTime="15:30" pax="6" reserved="2" available="4"/>
<PLANBOARD_ITEMS attractionID="BB218" sessionID="" attraction="BE A SEA LION TRAINER" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB218" sessionID="HCB32723" attraction="" venueName="SEA LION TRAINER FOR A DAY" startTime="11:30" endTime="12:15" pax="6" reserved="2" available="4"/>
<PLANBOARD_ITEMS attractionID="BB218" sessionID="HCB32754" attraction="" venueName="SEA LION TRAINER FOR A DAY" startTime="14:00" endTime="14:45" pax="6" reserved="0" available="6"/>
<PLANBOARD_ITEMS attractionID="BB218" sessionID="HCB32785" attraction="" venueName="SEA LION TRAINER FOR A DAY" startTime="15:00" endTime="15:45" pax="6" reserved="1" available="5"/>
<PLANBOARD_ITEMS attractionID="CB70" sessionID="" attraction="SUPER TOY COLLECTION" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="CB70" sessionID="CB32156" attraction="" venueName="SUPER TOY MUSEUM" startTime="00:01" endTime="23:59" pax="10000" reserved="526" available="9474"/>
<PLANBOARD_ITEMS attractionID="BB12" sessionID="" attraction="SYMPHONY EVENING SHOW" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB12" sessionID="CB32125" attraction="" venueName="SYMPHONY EVENING SHOW" startTime="17:45" endTime="19:00" pax="1600" reserved="686" available="914"/>
<PLANBOARD_ITEMS attractionID="BB11" sessionID="" attraction="TRAILS TO ANTARCTICA" venueName="" startTime="" endTime="" pax="" reserved="" available=""/>
<PLANBOARD_ITEMS attractionID="BB11" sessionID="CB31612" attraction="" venueName="TRAILS TO ANTARCTICA" startTime="06:00" endTime="20:00" pax="8000" reserved="390" available="7610"/>
<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_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 |
#PLANBOARD_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 attractionID |
#PLANBOARD_ITEMS@attractionID | High | Unique alphanumeric attraction ID from EHORS to identify the attractions, it may also use as BDIID
|
#PLANBOARD_ITEMS@sessionID | High | Unique alphanumeric session ID from EHORS to identify the session within an attraction, it may also use as planBoardID |
#PLANBOARD_ITEMS@attraction | High | Attraction name define in EHORS system by customer, if data is blank identify as session element |
#PLANBOARD_ITEMS@venueName | High | Venue name of the session hosted, define by customer in EHORS system, if data is blank identify as attraction element |
#PLANBOARD_ITEMS@startTime | High | Start time in format of HH:mm of the session, if data is blank identify as attraction element |
#PLANBOARD_ITEMS@endTime | High | End time in format of HH:mm of the session, if data is blank identify as attraction element |
#PLANBOARD_ITEMS@pax | High | Maximum capacity of the venue of the session can handle, if data is blank identify as attraction element |
#PLANBOARD_ITEMS@reserved | High | Number of pax already reserved in EHORS system, if data is blank identify as attraction element |
#PLANBOARD_ITEMS@available | High | Security check on maximum pax minus reserved, show directly the available left for this session, if data is blank identify as attraction element |