Application File Imports Release Notes Sync Web Services FAQ

WS Calls

System Location: Web / Services

The WS Calls represent the latest version of web services available within ALP SaaS.  These latest "calls" feature improved performance, enhanced logging and easier configuration.

Calls that can be provided a specific member's Id(s) will have that parameter overridden for the primary member involved, in the event that a member temporary token is used.

Note: As a common rule of thumb, Id settings and Id statuses are not observed for input.  Active Id status is only enforced for the Transaction method, IssueChoiceReward, IssueChoiceRewardExtended, IssueMultipleChoiceRewards, IssueMultipleChoiceRewardsExtended, IssueVariableReward, SubmitMemberRetroClaim and CrossPortalLogin.  ID Type Auto Ranges are only supported as of 2017.5, for the "Issue" calls within the Transaction method.

Case

Method Documentation (https://app.smartbutton.com/WS/Case.asmx)

CloseCase

CreateMemberCase

FetchFeedbackTypes

FetchMemberCaseHistory

SendPublicCaseNotification

Campaign

Method Documentation (https://app.smartbutton.com/WS/Campaign.asmx)

SaveBounceAction

SaveOpenAction

SetSendStatus

Device

Method Documentation (https://app.smartbutton.com/WS/Device.asmx)

DeviceDashboard

DeviceInService

DeviceOutOfService

EpicorInterface

Method Documentation (https://app.smartbutton.com/WS/EpicorInterface.asmx)

EpicorProcessEndOfSale

EpicorReturnOfferCodes

EpicorVoidEndOfSale

Import

Method Documentation (https://app.smartbutton.com/WS/Import.asmx)

UploadFile

RetImportFileErrors

RetImportFileLog

Interaction

Method Documentation (https://app.smartbutton.com/WS/Interaction.asmx)

IssueInteractionTermsAcceptance

IssueInteractionUserDefined

JDAInterface

Method Documentation (https://app.smartbutton.com/WS/JDAInterface.asmx)

JDAProcessEndOfSale

JDAReturnOfferCodes

JDAVoidEndOfSale

Member

Method Documentation (https://app.smartbutton.com/WS/Member.asmx)

AddMemberAccountId

AddMemberChildInfo

AddMemberToClub

AssignMemberToHeadOfHousehold

ClearDependentFromHeadOfHousehold

DeleteMember

DeleteMemberAccountId

EnrollMember

EnrollMemberWithAccountPhoneNumber

EnrollMemberWithCard

EnrollMemberWithEmail

EnrollMemberWithGeneratedId

EnrollMemberWithMobilePhoneNumber

FetchHeadOfHouseholdDependents

FetchHeadOfHouseholdDependentsExtended

FetchMemberCore

FetchMemberAccountIDs

FetchMemberChildInfo

FetchMemberCustomFields

FetchMemberEnrollmentInfo

FetchMemberHeadofHouseholdStatus

FetchMemberHeadofHouseholdStatusExtended

FetchMemberLanguagePreference

FetchMemberPropertyCustomFields

FetchMemberState

FetchTypesMemberNamePrefix

FetchTypesMemberGender

MemberExistsInClub

MemberExistsInMemberDescriptor

RemoveMemberFromClub

SaveMemberActiveStatus

SaveMemberBirthdate

SaveMemberCustomFields

SaveMemberEmployeeStatus

SaveMemberGender

SaveMemberName

SaveMemberPointsLockedStatus

SaveMemberPrefCommLanguage

SaveMemberPropertyCustomFields

SaveMemberTwitterUsername

SetMemberClubs

SetMemberDescriptor

SetMemberDescriptors

UpdateExistingMemberAccountId

UpdateMemberDescriptorExpireDate

ValidateMemberAccountId

MemberActivity

Method Documentation (https://app.smartbutton.com/WS/MemberActivity.asmx)

FetchMember360ForSourceDateRange

FetchMemberExpirations

FetchMemberExpirationsForDateRange

FetchMemberHistory

FetchMemberHistoryPrefLanguage

FetchMemberHistoryForDateRange

FetchMemberHistoryPrefLanguageForDateRange

FetchMemberInteractionsForDateRange

FetchMemberIssuedRewards

FetchMemberIssuedRewardsForDateRange

FetchMemberIssuedRewardsForDateRangeWithCustomFields

FetchMemberNextPointsToExpire

FetchMemberPointBalances

FetchMemberPointBalancesForSourceDateRange

FetchMemberPointsToAutoExpire

FetchMemberTransactions

FetchMemberTransactionsForDateRange

FetchMemberTransactionsForDateRangeExt

MemberContact

Method Documentation (https://app.smartbutton.com/WS/MemberContact.asmx)

FetchMemberAccountPhoneNumber

FetchMemberContactInfo

FetchMemberEmailAddress

FetchMemberMobilePhoneNumber

FetchMemberPostalAddress

FetchMemberPhoneNumbers

FetchAddressCountryList

FetchAddressRegionList

SaveMemberAccountPhoneNumber

SaveMemberEmailAddress

SaveMemberMobilePhoneNumber

SaveMemberPhoneNumbers

SaveMemberPostalAddress

MemberReferrer

Method Documentation (https://app.smartbutton.com/WS/MemberReferrer.asmx)

CreateReferrerCode

FetchMemberReferees

FetchMemberReferrerInfo

ProcessReferredBy

ProcessReferredByCode

MemberSecurity

Method Documentation (https://app.smartbutton.com/WS/MemberSecurity.asmx)

ChangePassword

ChangePIN

EmailVerificationIssueCode

EmailVerificationSubmitCode

EnrollmentVerificationIssueCode

EnrollmentVerificationSubmitCode

FetchMemberLastPasswordChangeDate

SetPassword

SetPIN

TextVerificationIssueCode

TextVerificationSubmitCode

ValidatePassword

ValidatePIN

Message

Method Documentation (https://app.smartbutton.com/WS/Message.asmx)

FetchMemberPreferredDeliveryMethod

FetchMemberOptOutSettings

FetchPreferredDeliveryMethodTypesForOffers

FetchPreferredDeliveryMethodTypesForNonOffers

SaveMemberOptOutSettings

SaveMemberPreferredDeliveryMethod

SaveMemberPreferredDeliveryMethodForOffers

SaveMemberPreferredDeliveryMethodForNonOffers

SendPasswordMessage

SendWelcomeMessage

SetMemberOptOutEmail

SetMemberOptOutMail

SetMemberOptOutPhone

SetMemberOptOutText

Offer

Method Documentation (https://app.smartbutton.com/WS/Offer.asmx)

CancelMemberReward

CancelMemberRewards

FetchChoiceRewardWithLanguages

FetchMemberChoiceRewardList

FetchRewardTypeIssueLimit

FetchRewardTypeIssueStatistics

FetchMemberReward

FetchMemberRewardCustomFields

FetchMemberRewardViewURL

FetchRewardCustomFields

IssueChoiceReward

IssueChoiceRewardExtended

IssueMultipleChoiceRewards

IssueMultipleChoiceRewardsExtended

IssueVariableReward

MemberActiveRewards

MemberActiveRewardsEligibleForPOS

MemberActiveRewardsWithMemberRewardCustomFields

MemberActiveRewardsWithRewardCustomFields

MemberEligibleChoiceRewards

MemberEligibleChoiceRewardsExtended

MemberEligibleVariableRewards

MemberEligibleVariableRewardsExtended

PointsToNextRecurringReward

ReverseCouponRedemptionAndCancelCoupon

ReverseCouponRedemptionsAndCancelCoupons

RedeemMemberReward

RedeemMemberRewards

ReverseRewardRedemption

ReverseRewardRedemptionAndSetToPending

ReverseRewardRedemptions

ReverseRewardRedemptionsAndSetToPending

SaveMemberRewardCustomField

SaveMemberRewardCustomFields

SaveRewardTypeIssueLimit

ValidateMemberRewardBarcode

ValidateMemberRewardId

ValidateVariableRewardAmount

PointOfSale

Method Documentation (https://app.smartbutton.com/WS/PointOfSale.asmx)

POSMessagePromotion

ReturnCashierOfferCodes

RedeemCouponOffer

ReturnCouponOffers

Portal

Method Documentation (https://app.smartbutton.com/WS/Portal.asmx)

CrossPortalLogin

Promotion

Method Documentation (https://app.smartbutton.com/WS/Promotion.asmx)

InternetInstantWinnerPromotion

InternetInstantWinnerPromotionWithRewardInfo

InternetMessagePromotion

InternetMessagePopupPromotion

KeyCodePromotion

KeyCodePromotionExtended

ProductCodePromotion

ProductCodePromotionExtended

ProductItemPromotion

RecurringProductPromotionTracker

RetroClaim

Method Documentation (https://app.smartbutton.com/WS/RetroClaim.asmx)

FetchMatchingOutstandingRetroTransaction

FetchMemberRetroClaimHistory

SubmitMemberRetroClaim

SubmitMemberRetroClaimWithRetroTransactionId

Segment

Method Documentation (https://app.smartbutton.com/WS/Segment.asmx)

FetchMemberRankingSetStatus

MemberExistsInRankingLevel
 
MemberExistsInRankingSet
 
MemberExistsInCampaignGroup
 
MemberExistsInPromotionalGroup
 
MemberPromotionalGroups
 
MemberRankingLevelForSet
 
ProcessMemberRankingSetLevel

Support

Method Documentation (https://app.smartbutton.com/WS/Support.asmx)

GenerateMemberTemporaryToken

GenerateTemporaryToken

GetReturnCodeMessage

Survey

Method Documentation (https://app.smartbutton.com/WS/Survey.asmx)

SurveyAnswerQuestion

SurveyReturnNextQuestion

Transaction

Method Documentation (https://app.smartbutton.com/WS/Transaction.asmx)

CancelTransaction

FetchProduct

FetchProductCustomField

FetchTransaction

FetchTransactionBasket

FetchTransactionBonusPointDetails

FetchTransactionCustomFields

IssuePointAdjustment

IssuePointAdjustmentWithNote

IssuePointTransfer

IssueTransactionMultipleProductBasket

IssueTransactionMultipleProductBasketCustomFieldsBookingDate

IssueTransactionMultipleProductBasketWithCustomFields

IssueTransactionNoBasket

IssueTransactionNoBasketWithCustomFields

IssueTransactionSingleProductBasket

SaveProduct

SaveProductTransactionFlags

ScoreTransactionMultipleProductBasket

TransactionExternalReferenceExists

UpdateTransactionCustomFields

ValidateProduct

User

Method Documentation (https://app.smartbutton.com/WS/User.asmx)

ChangeUserPassword

CreateUser

CreateUserExt

DeleteUser

FetchUserCore

SetLoginForIdentity

SetUserPassword

SetUserPointAdjustmentLimit

SetUserSecurityRole

SetUserTimezone

Please note: All external ALP SaaS links and references are directed to US datacenter unless specifically noted.


Tags:
Home: Aimia Loyalty Platform SaaS Wiki
Copyright © 2003-2018 Smart Button, an Aimia Company. All rights reserved.
What's new: Recently changed articles