GIFT VOUCHER SEARCH V01

Service Reference Name: GIFT_VOUCHER_SEARCH_V01

Deprecated

This has been deprecated. Please refer to:

S_GIFT_VOUCHER_SEARCH_V002 - Replaced due to naming convention

General

This service searches for gift vouchers.

Input

sellDate (compulsory), sellTo: Period of sell date
giftVoucherNoFrom, giftVoucherNoTo: gift voucher number
externalReference
blocked, all, open: gift voucher state; only one field may be set with 1
holderName

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
gift voucher holder:
objid, lastName, matchcode
guestHotel, guestNo

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_SEARCH_V01Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Authentication>
        <SecurityID>string</SecurityID>
      </Authentication>
      <GiftvoucherSearch>
        <selldate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldate><!--Optional--><selldateto>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldateto><!--Optional--><giftVoucherNoFrom>Base: string Pattern: ([-+]){0,1}([0-9])*</giftVoucherNoFrom><!--Optional--><giftvouchernoto>Base: string Pattern: ([-+]){0,1}([0-9])*</giftvouchernoto><!--Optional--><externalreference>string</externalreference><!--Optional--><blocked>Base: string Pattern: ([-+]){0,1}([0-9])*</blocked><!--Optional--><all>Base: string Pattern: ([-+]){0,1}([0-9])*</all><!--Optional--><open>Base: string Pattern: ([-+]){0,1}([0-9])*</open><!--Optional--><holderName>string</holderName>
      </GiftvoucherSearch>
    </GIFT_VOUCHER_SEARCH_V01Request>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name	Type
GIFT_VOUCHER_SEARCH_V01Request
TransactionID	string
Authentication	Node
SecurityID	string
GiftvoucherSearch	Node
selldate	Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
selldateto	Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
giftVoucherNoFrom	Base: string Pattern: ([-+]){0,1}([0-9])*
giftvouchernoto	Base: string Pattern: ([-+]){0,1}([0-9])*
externalreference	string
blocked	Base: string Pattern: ([-+]){0,1}([0-9])*
all	Base: string Pattern: ([-+]){0,1}([0-9])*
open	Base: string Pattern: ([-+]){0,1}([0-9])*
holderName	string

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_SEARCH_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--><Giftvoucher>
        <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><!--Optional--><GiftvoucherHolder>
          <objid>Base: string Pattern: ([0-9])*</objid>
          <lastName>string</lastName>
          <firstName>Base: string minLength: 0 maxLength: 100</firstName>
          <matchcode>Base: string minLength: 0 maxLength: 20</matchcode>
          <guestHotel>Base: string Pattern: ([-+]){0,1}([0-9])*</guestHotel>
          <guestNo>Base: string Pattern: ([-+]){0,1}([0-9])*</guestNo>
        </GiftvoucherHolder>
      </Giftvoucher>
    </GIFT_VOUCHER_SEARCH_V01Response>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name	Type
GIFT_VOUCHER_SEARCH_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
Giftvoucher	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})
GiftvoucherHolder	Node
objid	Base: string Pattern: ([0-9])*
lastName	string
firstName	Base: string minLength: 0 maxLength: 100
matchcode	Base: string minLength: 0 maxLength: 20
guestHotel	Base: string Pattern: ([-+]){0,1}([0-9])*
guestNo	Base: string Pattern: ([-+]){0,1}([0-9])*