OnlineAPI


Click here for a complete list of operations.

GetGiftCardFields

For a given gift card account, this method will return the fields related to the gift card setup.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetGiftCardFields"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGiftCardFields xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <GiftCardAccountID>int</GiftCardAccountID>
    </GetGiftCardFields>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGiftCardFieldsResponse xmlns="http://www.securefreedom.com/">
      <GetGiftCardFieldsResult>
        <GiftCardField>
          <FieldName>string</FieldName>
          <FieldLabel>string</FieldLabel>
          <FieldType>string</FieldType>
          <Required>boolean</Required>
          <ValidationType>int</ValidationType>
        </GiftCardField>
        <GiftCardField>
          <FieldName>string</FieldName>
          <FieldLabel>string</FieldLabel>
          <FieldType>string</FieldType>
          <Required>boolean</Required>
          <ValidationType>int</ValidationType>
        </GiftCardField>
      </GetGiftCardFieldsResult>
    </GetGiftCardFieldsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGiftCardFields xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <GiftCardAccountID>int</GiftCardAccountID>
    </GetGiftCardFields>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGiftCardFieldsResponse xmlns="http://www.securefreedom.com/">
      <GetGiftCardFieldsResult>
        <GiftCardField>
          <FieldName>string</FieldName>
          <FieldLabel>string</FieldLabel>
          <FieldType>string</FieldType>
          <Required>boolean</Required>
          <ValidationType>int</ValidationType>
        </GiftCardField>
        <GiftCardField>
          <FieldName>string</FieldName>
          <FieldLabel>string</FieldLabel>
          <FieldType>string</FieldType>
          <Required>boolean</Required>
          <ValidationType>int</ValidationType>
        </GiftCardField>
      </GetGiftCardFieldsResult>
    </GetGiftCardFieldsResponse>
  </soap12:Body>
</soap12:Envelope>