|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
KioskSwipe |
Overview | |
Service URL: | https://app.kognitivloyalty.com/Services/Kiosk.asmx (Production) |
Service WSDL URL: | https://app.kognitivloyalty.com/Services/Kiosk.asmx?WSDL (Production) |
Method: | KioskSwipe |
Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/Kiosk.asmx?op=KioskSwipe (Production) |
Description: |
Processes a External Kiosk Swipe. -- Issues a Device Swipe Interaction -- Processes any 'Day' or 'Event' Admission Transactions -- Returns back Name and Up-to-Date Point Totals |
Interface | |
Input Parameters: | SecurityToken (String) - Web Service Security Token generated via the Aimia Loyalty Solutions Platform Application |
LoyaltyProgramId (Required)(Integer) - The Loyalty Program Id to validate (Hardcoded value for the specific Loyalty Program) | |
AccountId (String) - Required Max Length(60) | |
LocationExternalReference (String) - Required - Must Match a Location External Reference (see notes) | |
Returns: | Returns record of type 'respKioskSwipe' (defined below) |
Type: | respKioskSwipe |
Field: | ReturnCode (Interger) - Contains Return Code - possible values defined in 'Error Codes' section of this page |
Field: | ErrorMessage (String) - Blank if not 'Success', otherwise, String representation of the Return Code Error |
Field: | MemberFirstName (String) - Member First Name, Blank if Non Success Return Code |
Field: | MemberLastName (String) - Member LastName, Blank if Non Success Return Code |
Field: | PointsEarned (Double / Floating Point) - The Total Points Earned, Zero if Non Success Return Code |
Field: | PointsUsed (Double / Floating Point) - The Total Points Used for Rewards, Zero if Non Success Return Code |
Field: | PointsDeducted (Double / Floating Point) - The Total Points Deducted due to Negative Point Transactions (maybe refunds), Zero if Non Success Return Code |
Field: | PointsExpired (Double / Floating Point) - The Total Points Expired, Zero if Non Success Return Code |
Field: | PointsLocked (Double / Floating Point) - The Total Points Locked, Zero if Non Success Return Code |
Field: | PointsAvailable (Double / Floating Point) - The Total Points Available for Redemption, Zero if Non Success Return Code |
Additional Information | |
Notes: | |
Error Codes | |
Possible Return Codes: |
(0) - Sucess (1) - Undefined Error (Please Contact Support) (100) - Invalid Security Token (101) - Invalid Permission for Method (300) - InvalidCardNumber (301) - MemberCardNumberInactive (302) - Member Account is Suspended (303) - Invalid Loyalty Program Id (305) - Member is Not Enrolled in Loyalty Program (1002) - Invalid Location External Reference |
Reference | |
click for: | Web Services Overview |
link: | Web Services Map |
link: | SBLP Security Token Information |
Copyright © 2003-2021 Kognitiv, Corp. All rights reserved. |