Transaction Web Service

Kognitiv
130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2

Transaction

Click here for a complete list of operations.

FetchTransactionCustomFields

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 /WS/Transaction.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LoyaltyPlatformWS/FetchTransactionCustomFields"

<?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>
    <FetchTransactionCustomFields xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <AppTransactionId>int</AppTransactionId>
    </FetchTransactionCustomFields>
  </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>
    <FetchTransactionCustomFieldsResponse xmlns="LoyaltyPlatformWS">
      <FetchTransactionCustomFieldsResult>
        <ReturnCode>int</ReturnCode>
        <TransactionCustomFields>
          <TransactionCustomFieldItem>
            <TransactionCustomFieldName>string</TransactionCustomFieldName>
            <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
            <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
            <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
            <TransactionCustomFieldValue xsi:nil="true" />
          </TransactionCustomFieldItem>
          <TransactionCustomFieldItem>
            <TransactionCustomFieldName>string</TransactionCustomFieldName>
            <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
            <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
            <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
            <TransactionCustomFieldValue xsi:nil="true" />
          </TransactionCustomFieldItem>
        </TransactionCustomFields>
      </FetchTransactionCustomFieldsResult>
    </FetchTransactionCustomFieldsResponse>
  </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 /WS/Transaction.asmx HTTP/1.1
Host: app.kognitivloyalty.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>
    <FetchTransactionCustomFields xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <AppTransactionId>int</AppTransactionId>
    </FetchTransactionCustomFields>
  </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>
    <FetchTransactionCustomFieldsResponse xmlns="LoyaltyPlatformWS">
      <FetchTransactionCustomFieldsResult>
        <ReturnCode>int</ReturnCode>
        <TransactionCustomFields>
          <TransactionCustomFieldItem>
            <TransactionCustomFieldName>string</TransactionCustomFieldName>
            <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
            <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
            <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
            <TransactionCustomFieldValue xsi:nil="true" />
          </TransactionCustomFieldItem>
          <TransactionCustomFieldItem>
            <TransactionCustomFieldName>string</TransactionCustomFieldName>
            <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
            <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
            <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
            <TransactionCustomFieldValue xsi:nil="true" />
          </TransactionCustomFieldItem>
        </TransactionCustomFields>
      </FetchTransactionCustomFieldsResult>
    </FetchTransactionCustomFieldsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /WS/Transaction.asmx/FetchTransactionCustomFields?WSSecurityToken=string&AppTransactionId=string HTTP/1.1
Host: app.kognitivloyalty.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<FetchTransactionCustomFieldsReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <TransactionCustomFields>
    <TransactionCustomFieldItem>
      <TransactionCustomFieldName>string</TransactionCustomFieldName>
      <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
      <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
      <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
      <TransactionCustomFieldValue>
        <CheckboxValue>int</CheckboxValue>
        <IntegerValue>int</IntegerValue>
        <MoneyValue>double</MoneyValue>
        <TextValue>string</TextValue>
        <ListValue>string</ListValue>
        <ListValue>string</ListValue>
        <DateValue>string</DateValue>
        <DropDownValue>string</DropDownValue>
        <AddressValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
      </TransactionCustomFieldValue>
    </TransactionCustomFieldItem>
    <TransactionCustomFieldItem>
      <TransactionCustomFieldName>string</TransactionCustomFieldName>
      <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
      <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
      <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
      <TransactionCustomFieldValue>
        <CheckboxValue>int</CheckboxValue>
        <IntegerValue>int</IntegerValue>
        <MoneyValue>double</MoneyValue>
        <TextValue>string</TextValue>
        <ListValue>string</ListValue>
        <ListValue>string</ListValue>
        <DateValue>string</DateValue>
        <DropDownValue>string</DropDownValue>
        <AddressValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
      </TransactionCustomFieldValue>
    </TransactionCustomFieldItem>
  </TransactionCustomFields>
</FetchTransactionCustomFieldsReturn>

HTTP POST

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

POST /WS/Transaction.asmx/FetchTransactionCustomFields HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

WSSecurityToken=string&AppTransactionId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<FetchTransactionCustomFieldsReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <TransactionCustomFields>
    <TransactionCustomFieldItem>
      <TransactionCustomFieldName>string</TransactionCustomFieldName>
      <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
      <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
      <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
      <TransactionCustomFieldValue>
        <CheckboxValue>int</CheckboxValue>
        <IntegerValue>int</IntegerValue>
        <MoneyValue>double</MoneyValue>
        <TextValue>string</TextValue>
        <ListValue>string</ListValue>
        <ListValue>string</ListValue>
        <DateValue>string</DateValue>
        <DropDownValue>string</DropDownValue>
        <AddressValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
      </TransactionCustomFieldValue>
    </TransactionCustomFieldItem>
    <TransactionCustomFieldItem>
      <TransactionCustomFieldName>string</TransactionCustomFieldName>
      <TransactionCustomFieldPrompt>string</TransactionCustomFieldPrompt>
      <TransactionCustomFieldExternalReference>string</TransactionCustomFieldExternalReference>
      <TransactionCustomFieldDataType>int</TransactionCustomFieldDataType>
      <TransactionCustomFieldValue>
        <CheckboxValue>int</CheckboxValue>
        <IntegerValue>int</IntegerValue>
        <MoneyValue>double</MoneyValue>
        <TextValue>string</TextValue>
        <ListValue>string</ListValue>
        <ListValue>string</ListValue>
        <DateValue>string</DateValue>
        <DropDownValue>string</DropDownValue>
        <AddressValue d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
        <MultipleChoiceSelectedValue>string</MultipleChoiceSelectedValue>
      </TransactionCustomFieldValue>
    </TransactionCustomFieldItem>
  </TransactionCustomFields>
</FetchTransactionCustomFieldsReturn>