Page tree

Versions Compared

Key

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

General Purpose

The command will cancel the sales made from [ P_TKT_NewSales ] Add New Ticket Sales command and needed to execute when guest decide to cancel the booking or failed from the payment gateway or failed from payment gateway.

Request Parameter

Variable Name

Variable Type

Explain

Example

dateOfSalespackageID
reservationID
Date(YYYY-mm-dd)Date of sales, by given which date of sales to combine with packageID to fetch available attractions and session bundled in the package2017-11-03ABCD1234
Varchar(255)Reservation ID which returned from [ P_TKT_NewSales ] Add New Ticket SalesABC1234
cancellationReasonVarchar(255)
Package ID retrieve from [ G_ATT_Package ] Get Available Attraction Package, with combinations of above variable dateOfSales, if package are within validations dates, bundled attractions along with its session will be return
Description of why this cancellation is being performed, it may cause by user action or time out or payment gateway reject or cancel from the payment gatewayCancel from a payment gateway/ insufficient funds

Sample Request with JS

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

$(document).ready(function(){
    $.ajax({
        url:"https://api.ehors.com",
        method:'POST',
        dataType:'xml',
        data:{
            accessID:'ABC123',
            accessKey:'XYZ576abc',
            moduleCode:'

TicketSales

P_TKT_CancelSales',
            command:'G_PKG_Details',
            

dateOfSales

reservationID:'

2017-11-03

ABC1234',

            packageID

            cancellationReason:'

ABCD1234

Cancel from a payment gateway'
        },
        success:function(response){
            console.log(response);
        }
    })
});

Sample request with CURL

curl -d "accessID=ABC123&accessKey=XYZ576abc&moduleCode=TicketSales&command=

G

P_

PKG

TKT_

Details

CancelSales&

dateOfSales=2017-11-03&packageID=ABCD1234

reservationID=ABC1234&cancellationReason=Cancel from a payment gateway" -X POST https://api.ehors.com

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

<?xml

 

version="1.0"

 

encoding="utf-8"?>

<SCRIPT

<SCRIPT_

RESULT>
  <RESULT>
    <ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="ALL STAR BIRDS SHOW" itemPrice="40.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="" itemPrice="" itemPrice_1="40.00" sessionID="CB31458" session="12:45 - 13:45" totalPrice="0.00" option_1="n" pass="1" max="1421" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB23" itemType="BDI" itemName="" itemPrice="" itemPrice_1="40.00" sessionID="CB31489" session="15:45 - 16:45" totalPrice="0.00" option_1="n" pass="1" max="1459" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB25" itemType="BDI" itemName="BACK OF THE HOUSE" itemPrice="20.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB25" itemType="BDI" itemName="" itemPrice="" itemPrice_1="20.00" sessionID="CB31582" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="2740" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB9" itemType="BDI" itemName="BIRDS OF PREY KINGDOM" itemPrice="50.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB9" itemType="BDI" itemName="" itemPrice="" itemPrice_1="50.00" sessionID="CB31675" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="7115" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB514" itemType="BDI" itemName="CREEPY CRAWLIES" itemPrice="20.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB514" itemType="BDI" itemName="" itemPrice="" itemPrice_1="20.00" sessionID="CB31644" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="6621" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB13" itemType="BDI" itemName="FISH SPA" itemPrice="20.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB13" itemType="BDI" itemName="" itemPrice="" itemPrice_1="20.00" sessionID="CB31551" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="6923" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB15" itemType="BDI" itemName="JELLIES EXHIBIT" itemPrice="40.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB15" itemType="BDI" itemName="" itemPrice="" itemPrice_1="40.00" sessionID="HBB32509" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="7438" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB10" itemType="BDI" itemName="OCEANARIUM" itemPrice="180.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB10" itemType="BDI" itemName="" itemPrice="" itemPrice_1="180.00" sessionID="CB31334" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="6538" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB16" itemType="BDI" itemName="PENGUIN TALK SHOW" itemPrice="100.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB16" itemType="BDI" itemName="" itemPrice="" itemPrice_1="100.00" sessionID="HCB32543" session="00:01 - 16:59" totalPrice="0.00" option_1="n" pass="1" max="7788" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB17" itemType="BDI" itemName="SEA LION SHOW" itemPrice="50.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB17" itemType="BDI" itemName="" itemPrice="" itemPrice_1="50.00" sessionID="CB31365" session="10:15 - 11:30" totalPrice="0.00" option_1="n" pass="1" max="1460" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB17" itemType="BDI" itemName="" itemPrice="" itemPrice_1="50.00" sessionID="CB31396" session="14:15 - 15:30" totalPrice="0.00" option_1="n" pass="1" max="973" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB17" itemType="BDI" itemName="" itemPrice="" itemPrice_1="50.00" sessionID="CB31427" session="16:15 - 17:30" totalPrice="0.00" option_1="n" pass="1" max="978" 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"/>
    <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="8905" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB12" itemType="BDI" itemName="SYMPHONY EVENING SHOW" itemPrice="100.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB12" itemType="BDI" itemName="" itemPrice="" itemPrice_1="100.00" sessionID="CB32126" session="17:45 - 19:00" totalPrice="0.00" option_1="n" pass="1" max="484" autoAssign="y"/>
    <ATTRACTION_ITEMS itemID="BB11" itemType="BDI" itemName="TRAILS TO ANTARCTICA" itemPrice="50.00" sessionID="" session="" totalPrice="" option_1="n" pass="1" max="" autoAssign="n"/>
    <ATTRACTION_ITEMS itemID="BB11" itemType="BDI" itemName="" itemPrice="" itemPrice_1="50.00" sessionID="CB31613" session="06:00 - 20:00" totalPrice="0.00" option_1="n" pass="1" max="6881" autoAssign="y"/>
    <PROPERTY_DISCOUNTS senDiscPerc="20.00" senDiscVatExem="y" pwdDiscPerc="20.00" pwdDiscVatExem="y"/>
    <SPECIAL_VARIABLES totalBDICount="12"/>
    <CONSTANTS mode="scheduled" countryID="52" outletID="BB37"/>
  </RESULT>
  <SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS>
</SCRIPT_RESULT>

...

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>

RESULT>
<RESULT/>
<SCRIPT_STATUS>SUCCESS</SCRIPT_STATUS>
</SCRIPT_RESULT>


XML Node Explain

Node

Importance 

Explain

#PROPERTY_DISCOUNTLowThis node are use to provide system discount from EHORS, can be ignore

Sample package details in EHORS system

Image Modified