TOP

GetGiftCard()

Part Of: Gift Card Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/GiftCardService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/GiftCardService.cfc?wsdl

Description:

Use the GetGiftCard() function to return a single gift card. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteID UUID  

Available For Enterprise Webservices
UUID of the Vin65 Website
Not necessary if GiftCardID is present
Useful if searching by CardNumber or Code
and CardNumber or Code is not unique across Enterprise

GiftCardID* UUID   UUID of the Vin65 Gift Card
One of either the GiftCardID, CardNumber, or Code is required.
CardNumber* Integer   One of either the GiftCardID, CardNumber, or Code is required.
Code* String 50   One of either the GiftCardID, CardNumber, or Code is required.

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSche ma-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <GetGiftCard>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>02FC83E3-5EB4-4AA7-A64A-9710BFD9A12A</WebsiteID>
      <Code>6TABEHSZZQUSANPX</Code>
    </Request>
  </GetGiftCard>
</soap:Body>
</soap:Envelope>  

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <GetGiftCardResponse>
    <GetGiftCardReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <GiftCard>
        <CardNumber>1066</CardNumber> 
        <Code>6TABEHSZZQUSANPX</Code>
        <CurrentBalance>70.00</CurrentBalance>
        <DateAdded>2011-03-02T17:49:32.407Z</DateAdded>
        <DateModified>2011-03-02T17:49:32.407Z</DateModified>
        <ExpiryDate/>
        <GiftCardID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</GiftCardID>
        <InitialAmount>70.00</InitialAmount>
        <IsActive>true</IsActive>
        <Notes/>
        <Title>Sample Gift Card Title</Title>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </GiftCard>
      <RecordCount>1</RecordCount>
    </GetGiftCardReturn>
  </GetGiftCardResponse>
</soapenv:Body>
</soapenv:Envelope> 

Page Top