Skip to content

GIFT VOUCHER SELL V01

Service Reference Name: GIFT_VOUCHER_SELL_V01

Deprecated

This has been deprecated. Please refer to:

General

This service performs a gift voucher sale.

Input

  • guestObjID: unique id of a guest
  • serviceCode: service code
  • amount: amount of the gift voucher
  • typeOfPayment: type of payment

Output

  • objid: unique id
  • status:
    • 1 = valid
    • 2 = not valid
    • 3 = redeemed
    • 4 = invoiced
    • 5 = suspended
    • 6 = incomplete
    • 7 = unavailable
  • number, externalReference
  • amount
  • sellDate, hotelSell, expiryDate

Direction

SIHOT.PMS ← IF Partner

Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <GIFT_VOUCHER_SELL_V01Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Authentication>
        <SecurityID>string</SecurityID>
      </Authentication>
      <GiftVoucherSell>
        <guestObjID>Base: string Pattern: ([0-9])*</guestObjID>
        <serviceCode>string</serviceCode>
        <amount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</amount>
        <typeofpayment>string</typeofpayment><!--Optional--><externalreference>string</externalreference><!--Optional--><expirydate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</expirydate>
      </GiftVoucherSell>
    </GIFT_VOUCHER_SELL_V01Request>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name Type
GIFT_VOUCHER_SELL_V01Request
TransactionID string
Authentication Node
SecurityID string
GiftVoucherSell Node
guestObjID Base: string Pattern: ([0-9])*
serviceCode string
amount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
typeofpayment string
externalreference string
expirydate Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <GIFT_VOUCHER_SELL_V01Response xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Result>
        <Success>Base: string Pattern: true or false</Success><!--Optional--><ErrorMsg>string</ErrorMsg><!--Optional--><MSG-LIST><!--Optional--><MSG-ENTRY><!--Optional--><MSG-LEVEL>Base: string Pattern: ERROR or WARNING or INFO</MSG-LEVEL><!--Optional--><MSG-CLASS>string</MSG-CLASS><!--Optional--><MSG-NO>Base: string Pattern: ([0-9])*</MSG-NO><!--Optional--><MSG-TEXT>string</MSG-TEXT><!--Optional--><MSG-ENTRY-PARAM-LIST><!--Optional--><PARAM><!--Optional--><INDEX>Base: string Pattern: ([0-9])*</INDEX><!--Optional--><VALUE>string</VALUE>
              </PARAM>
            </MSG-ENTRY-PARAM-LIST><!--Optional--><MSG-COMMENT>string</MSG-COMMENT><!--Optional--><MSG-SUPRESSED>string</MSG-SUPRESSED>
          </MSG-ENTRY>
        </MSG-LIST>
      </Result><!--Optional--><NewGiftvoucher>
        <objid>Base: string Pattern: ([0-9])*</objid>
        <status>string</status>
        <number>Base: string Pattern: ([-+]){0,1}([0-9])*</number>
        <externalreference>Base: string minLength: 0 maxLength: 20</externalreference>
        <amount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</amount>
        <selldate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldate>
        <hotelsell>Base: string Pattern: ([-+]){0,1}([0-9])*</hotelsell>
        <expirydate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</expirydate>
      </NewGiftvoucher>
    </GIFT_VOUCHER_SELL_V01Response>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name Type
GIFT_VOUCHER_SELL_V01Response
TransactionID string
Result Node
Success Base: string Pattern: true or false
ErrorMsg string
MSG-LIST Node
MSG-ENTRY Node
MSG-LEVEL Base: string Pattern: ERROR or WARNING or INFO
MSG-CLASS string
MSG-NO Base: string Pattern: ([0-9])*
MSG-TEXT string
MSG-ENTRY-PARAM-LIST Node
PARAM Node
INDEX Base: string Pattern: ([0-9])*
VALUE string
MSG-COMMENT string
MSG-SUPRESSED string
NewGiftvoucher Node
objid Base: string Pattern: ([0-9])*
status string
number Base: string Pattern: ([-+]){0,1}([0-9])*
externalreference Base: string minLength: 0 maxLength: 20
amount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
selldate Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
hotelsell Base: string Pattern: ([-+]){0,1}([0-9])*
expirydate Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})