LoyaltyMember Web Service

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

LoyaltyMember

Click here for a complete list of operations.

EnrollLoyaltyMember

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 /Services/LoyaltyMember.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://app.smartbutton.com/Services/LoyaltyMember/EnrollLoyaltyMember"

<?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>
    <EnrollLoyaltyMember xmlns="https://app.smartbutton.com/Services/LoyaltyMember">
      <preqEnrollLoyaltyMember>
        <SecurityToken>string</SecurityToken>
        <LocationExternalReference>string</LocationExternalReference>
        <AccountIdTypeExternalReference>string</AccountIdTypeExternalReference>
        <AccountId>string</AccountId>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Suffix>string</Suffix>
        <NickName>string</NickName>
        <Birthdate>string</Birthdate>
        <Gender>string</Gender>
        <EnrollmentTimestamp>string</EnrollmentTimestamp>
        <AddressTypeExternalReference>string</AddressTypeExternalReference>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <AddressLine3>string</AddressLine3>
        <City>string</City>
        <Region>string</Region>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <AddressIsValid>int</AddressIsValid>
        <EmailTypeExternalReference>string</EmailTypeExternalReference>
        <EmailAddress>string</EmailAddress>
        <EmailIsValid>int</EmailIsValid>
        <PhoneNumberTypeExternalReference>string</PhoneNumberTypeExternalReference>
        <PhoneNumber>string</PhoneNumber>
        <MobileCarrierExternalReference>string</MobileCarrierExternalReference>
        <PhoneNumberIsValid>int</PhoneNumberIsValid>
        <Password>string</Password>
        <IsEmployee>int</IsEmployee>
        <IsSuspended>int</IsSuspended>
        <IsLocked>int</IsLocked>
        <DoNotCall>int</DoNotCall>
        <DoNotMail>int</DoNotMail>
        <DoNotEmail>int</DoNotEmail>
        <DoNotText>int</DoNotText>
        <CustomFieldPairs>
          <recCustomFieldKeyValuePair>
            <CustomFieldExternalReference>string</CustomFieldExternalReference>
            <CustomFieldValue>string</CustomFieldValue>
          </recCustomFieldKeyValuePair>
          <recCustomFieldKeyValuePair>
            <CustomFieldExternalReference>string</CustomFieldExternalReference>
            <CustomFieldValue>string</CustomFieldValue>
          </recCustomFieldKeyValuePair>
        </CustomFieldPairs>
      </preqEnrollLoyaltyMember>
    </EnrollLoyaltyMember>
  </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>
    <EnrollLoyaltyMemberResponse xmlns="https://app.smartbutton.com/Services/LoyaltyMember">
      <EnrollLoyaltyMemberResult>
        <ReturnCode>int</ReturnCode>
        <MemberId>int</MemberId>
        <SavedAddressLine1>string</SavedAddressLine1>
        <SavedAddressLine2>string</SavedAddressLine2>
        <SavedAddressLine3>string</SavedAddressLine3>
        <SavedCity>string</SavedCity>
        <SavedRegion>string</SavedRegion>
        <SavedRegionAbbrev>string</SavedRegionAbbrev>
        <SavedPostalCode>string</SavedPostalCode>
        <SavedCountry>string</SavedCountry>
        <SavedCountryAbbrev>string</SavedCountryAbbrev>
        <SavedEmailAddress>string</SavedEmailAddress>
        <SavedPhoneNumber>string</SavedPhoneNumber>
      </EnrollLoyaltyMemberResult>
    </EnrollLoyaltyMemberResponse>
  </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 /Services/LoyaltyMember.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>
    <EnrollLoyaltyMember xmlns="https://app.smartbutton.com/Services/LoyaltyMember">
      <preqEnrollLoyaltyMember>
        <SecurityToken>string</SecurityToken>
        <LocationExternalReference>string</LocationExternalReference>
        <AccountIdTypeExternalReference>string</AccountIdTypeExternalReference>
        <AccountId>string</AccountId>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <Suffix>string</Suffix>
        <NickName>string</NickName>
        <Birthdate>string</Birthdate>
        <Gender>string</Gender>
        <EnrollmentTimestamp>string</EnrollmentTimestamp>
        <AddressTypeExternalReference>string</AddressTypeExternalReference>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <AddressLine3>string</AddressLine3>
        <City>string</City>
        <Region>string</Region>
        <PostalCode>string</PostalCode>
        <Country>string</Country>
        <AddressIsValid>int</AddressIsValid>
        <EmailTypeExternalReference>string</EmailTypeExternalReference>
        <EmailAddress>string</EmailAddress>
        <EmailIsValid>int</EmailIsValid>
        <PhoneNumberTypeExternalReference>string</PhoneNumberTypeExternalReference>
        <PhoneNumber>string</PhoneNumber>
        <MobileCarrierExternalReference>string</MobileCarrierExternalReference>
        <PhoneNumberIsValid>int</PhoneNumberIsValid>
        <Password>string</Password>
        <IsEmployee>int</IsEmployee>
        <IsSuspended>int</IsSuspended>
        <IsLocked>int</IsLocked>
        <DoNotCall>int</DoNotCall>
        <DoNotMail>int</DoNotMail>
        <DoNotEmail>int</DoNotEmail>
        <DoNotText>int</DoNotText>
        <CustomFieldPairs>
          <recCustomFieldKeyValuePair>
            <CustomFieldExternalReference>string</CustomFieldExternalReference>
            <CustomFieldValue>string</CustomFieldValue>
          </recCustomFieldKeyValuePair>
          <recCustomFieldKeyValuePair>
            <CustomFieldExternalReference>string</CustomFieldExternalReference>
            <CustomFieldValue>string</CustomFieldValue>
          </recCustomFieldKeyValuePair>
        </CustomFieldPairs>
      </preqEnrollLoyaltyMember>
    </EnrollLoyaltyMember>
  </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>
    <EnrollLoyaltyMemberResponse xmlns="https://app.smartbutton.com/Services/LoyaltyMember">
      <EnrollLoyaltyMemberResult>
        <ReturnCode>int</ReturnCode>
        <MemberId>int</MemberId>
        <SavedAddressLine1>string</SavedAddressLine1>
        <SavedAddressLine2>string</SavedAddressLine2>
        <SavedAddressLine3>string</SavedAddressLine3>
        <SavedCity>string</SavedCity>
        <SavedRegion>string</SavedRegion>
        <SavedRegionAbbrev>string</SavedRegionAbbrev>
        <SavedPostalCode>string</SavedPostalCode>
        <SavedCountry>string</SavedCountry>
        <SavedCountryAbbrev>string</SavedCountryAbbrev>
        <SavedEmailAddress>string</SavedEmailAddress>
        <SavedPhoneNumber>string</SavedPhoneNumber>
      </EnrollLoyaltyMemberResult>
    </EnrollLoyaltyMemberResponse>
  </soap12:Body>
</soap12:Envelope>