Skip to content

S_GIFT_VOUCHER_SEARCH_V002

This service searches for gift vouchers:

Input (searchcriteria):

  • sellDate (compulusory), 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

  • redemptionDate, redemptionDateTo: gift voucher redemption date

  • hotelSell

Output (List of gift vouchers):

  • 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:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 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>
<S_GIFT_VOUCHER_SEARCH_V002Request xmlns="http://www.gubse.com/IFS/test.xsd">
<!--Optional-->
<TransactionID>string</TransactionID>
<Authentication>
<SecurityID>string</SecurityID>
</Authentication>
<GiftvoucherSearch>
<!--Optional-->
<selldate>([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldate>
<!--Optional-->
<selldateto>([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldateto>
<!--Optional-->
<giftVoucherNoFrom>([-+]){0,1}([0-9])*</giftVoucherNoFrom>
<!--Optional-->
<giftvouchernoto>([-+]){0,1}([0-9])*</giftvouchernoto>
<!--Optional-->
<externalreference>string</externalreference>
<!--Optional-->
<blocked>([-+]){0,1}([0-9])*</blocked>
<!--Optional-->
<all>([-+]){0,1}([0-9])*</all>
<!--Optional-->
<open>([-+]){0,1}([0-9])*</open>
<!--Optional-->
<holderName>string</holderName>
<!--Optional-->
<redemptiondate>([0-9]{4})-([0-9]{2})-([0-9]{2})|</redemptiondate>
<!--Optional-->
<redemptiondateto>([0-9]{4})-([0-9]{2})-([0-9]{2})|</redemptiondateto>
<!--Optional-->
<hotelsell>string</hotelsell>
<!--Optional-->
<hotelredeem>string</hotelredeem>
</GiftvoucherSearch>
</S_GIFT_VOUCHER_SEARCH_V002Request>
</soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name Type
S_GIFT_VOUCHER_SEARCH_V002Request
TransactionID string
Authentication Node
SecurityID string
GiftvoucherSearch Node
selldate ([0-9]{4})-([0-9]{2})-([0-9]{2})
selldateto ([0-9]{4})-([0-9]{2})-([0-9]{2})
giftVoucherNoFrom ([-+]){0,1}([0-9])*
giftvouchernoto ([-+]){0,1}([0-9])*
externalreference string
blocked ([-+]){0,1}([0-9])*
all ([-+]){0,1}([0-9])*
open ([-+]){0,1}([0-9])*
holderName string
redemptiondate ([0-9]{4})-([0-9]{2})-([0-9]{2})
redemptiondateto ([0-9]{4})-([0-9]{2})-([0-9]{2})
hotelsell string
hotelredeem string

Response

<soapenv:Envelope xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 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>
<S_GIFT_VOUCHER_SEARCH_V002Response xmlns="http://www.gubse.com/IFS/test.xsd">
<!--Optional-->
<TransactionID>string</TransactionID>
<Result>
<Success>true or false</Success>
<!--Optional-->
<ErrorMsg>string</ErrorMsg>
<!--Optional-->
<MSG-LIST>
<!--Optional-->
<MSG-ENTRY>
<!--Optional-->
<MSG-LEVEL>ERROR or WARNING or INFO</MSG-LEVEL>
<!--Optional-->
<MSG-CLASS>string</MSG-CLASS>
<!--Optional-->
<MSG-NO>([0-9])*</MSG-NO>
<!--Optional-->
<MSG-TEXT>string</MSG-TEXT>
<!--Optional-->
<MSG-ENTRY-PARAM-LIST>
<!--Optional-->
<PARAM>
<!--Optional-->
<INDEX>([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>([0-9])*</objid>
<status>string</status>
<number>([-+]){0,1}([0-9])*</number>
<externalreference>string</externalreference>
<amount>([-+]){0,1}([0-9])*\.{0,1}([0-9])*</amount>
<selldate>([0-9]{4})-([0-9]{2})-([0-9]{2})|</selldate>
<hotelsell>([-+]){0,1}([0-9])*</hotelsell>
<expirydate>([0-9]{4})-([0-9]{2})-([0-9]{2})|</expirydate>
<redemptiondate>([0-9]{4})-([0-9]{2})-([0-9]{2})|</redemptiondate>
<hotelredeem>([-+]){0,1}([0-9])*</hotelredeem>
<!--Optional-->
<GiftvoucherHolder>
<objid>([0-9])*</objid>
<lastName>string</lastName>
<firstName>string</firstName>
<matchcode>string</matchcode>
<guestHotel>([-+]){0,1}([0-9])*</guestHotel>
<guestNo>([-+]){0,1}([0-9])*</guestNo>
</GiftvoucherHolder>
</Giftvoucher>
</S_GIFT_VOUCHER_SEARCH_V002Response>
</soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name Type
S_GIFT_VOUCHER_SEARCH_V002Response
TransactionID string
Result Node
Success true or false
ErrorMsg string
MSG-LIST Node
Giftvoucher Node
objid ([0-9])*
status string
number ([-+]){0,1}([0-9])*
externalreference string
amount ([-+]){0,1}([0-9]).{0,1}([0-9])
selldate ([0-9]{4})-([0-9]{2})-([0-9]{2})
hotelsell ([-+]){0,1}([0-9])*
expirydate ([0-9]{4})-([0-9]{2})-([0-9]{2})
redemptiondate ([0-9]{4})-([0-9]{2})-([0-9]{2})
hotelredeem ([-+]){0,1}([0-9])*
GiftvoucherHolder Node