RedeemGiftVoucher

Service Reference Name: RedeemGiftVoucher

General

The request allows gift vouchers to be redeemed on redeemgiftvoucher.

REQUEST

The request requires the following additional tags:

redeemgiftvoucher: external gift voucher number (optional)

mandator: Number of the mandator in which the guest stays.

RedeemGiftVoucherReqType

Remark: It is not possible to redeem only part of the value of the gift voucher, so the value here needs to be the same as the value sent in the answer to the giftvoucherreq.

RESPONSE

The answer is of type Result and RedeemGiftVoucherResType.

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>
    <RedeemGiftVoucherRequest xmlns="http://www.gubse.com/IFS/RMS.xsd">
      <TransactionID>string</TransactionID>
      <Authentification>
        <SecurityID>string</SecurityID>
      </Authentification>
      <redeemgiftvoucher>string</redeemgiftvoucher><!--Optional--><mandator>Base: string Pattern: ([0-9])*</mandator>
      <block_giftvoucher>
        <value>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</value><!--Optional--><accountno>Base: string Pattern: ([0-9])*</accountno><!--Optional--><voucherno>Base: string Pattern: ([0-9])*</voucherno><!--Optional--><source>Base: string Pattern: Guest or Z-POS</source>
      </block_giftvoucher>
    </RedeemGiftVoucherRequest>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name	Type
RedeemGiftVoucherRequest
TransactionID	string
Authentification	Node
SecurityID	string
redeemgiftvoucher	string
mandator	Base: string Pattern: ([0-9])*
block_giftvoucher	Node
value	Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
accountno	Base: string Pattern: ([0-9])*
voucherno	Base: string Pattern: ([0-9])*
source	Base: string Pattern: Guest or Z-POS

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>
    <RedeemGiftVoucherResponse xmlns="http://www.gubse.com/IFS/RMS.xsd">
      <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--><block_giftvoucher><!--Optional--><status>Base: string Pattern: BLOCKED or VALID or INVALID or NOTUSABLE</status>
        <value>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</value><!--Optional--><number>string</number><!--Optional--><accountno>Base: string Pattern: ([0-9])*</accountno><!--Optional--><voucherno>Base: string Pattern: ([0-9])*</voucherno><!--Optional--><source>Base: string Pattern: Guest or Z-POS</source>
      </block_giftvoucher>
    </RedeemGiftVoucherResponse>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name	Type
RedeemGiftVoucherResponse
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
block_giftvoucher	Node
status	Base: string Pattern: BLOCKED or VALID or INVALID or NOTUSABLE
value	Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
number	string
accountno	Base: string Pattern: ([0-9])*
voucherno	Base: string Pattern: ([0-9])*
source	Base: string Pattern: Guest or Z-POS