130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2
|
|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
|
|
| EnrollProspect |
| Overview | |
| Service URL: | https://app.kognitivloyalty.com/Services/Prospect.asmx (Production) |
| Service WSDL URL: | https://app.kognitivloyalty.com/Services/Prospect.asmx?WSDL (Production) |
| Method: | EnrollProspect |
| Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/Prospect.asmx?op=EnrollProspect (Production) |
| Description: | Enrolls a Prospect- IF ANY ERROR IS RETURNED, the entire enrollment is reversed and nothing is saved... |
| Interface | |
| Input Parameters: | Takes parameter 'preqEnrollProspect' of type 'reqEnrollProspect' (defined below) |
| Returns: | Returns record of type 'respEnrollProspect' (defined below) |
| Type: | reqEnrollProspect |
| Field: | SecurityToken (String) - Web Service Security Token generated via the Aimia Loyalty Solutions Platform Application |
| Field: | LocationExternalReference (String) Required - Location for Enrollment - External Reference setup via Application |
| Field: | AccountIdTypeExternalReference (String) - Account Id Type External Reference setup via Application |
| Field: | AccountId (String) - Account Id to Add or Modify (may be the same as 'AccountIdToModify') |
| Field: | FirstName (String) Required - First Name of Account |
| Field: | MiddleName (String) - Middle Name of Account |
| Field: | LastName (String) Required - Last Name of Account |
| Field: | Suffix (String) - Proper Name Suffix |
| Field: | NickName (String) - NickName of Account (used for Forum Posts) |
| Field: | Birthdate (String) - Blank for No Date, or a US-Formatted Date (i.e MM-DD-YYYY) |
| Field: | Gender (String) - Blank for Unknown, 'm' or 'Male' for Male, 'f', 'Female' for Female |
| Field: | EnrollmentTimestamp (String) - Enrollment Timestamp - if Blank, current timestamp is used (us format MM-DD-YYYY) |
| Field: | AddressTypeExternalReference (String) - Address Type External Reference setup via Application |
| Field: | AddressLine1 (String) - Address Line 1 |
| Field: | AddressLine2 (String) - Address Line 2 |
| Field: | AddressLine3 (String) - Address Line 3 |
| Field: | City (String) - Proper City Name |
| Field: | Region (String) - Region (State for United States, Province for Canada, ...) Name or Abbrevation |
| Field: | PostalCode (String) - ZipCode for United States, Postal Code for Canada, ...) Name or Abbrevation |
| Field: | Country (String) - Country Name or Abbrevation |
| Field: | AddressIsValid (Integer - 32bit) - (0) - False, Non-Zero Value for True |
| Field: | EmailTypeExternalReference (String) - Email Type External Reference setup via Application |
| Field: | EmailAddress (String) - Complete Email Address |
| Field: | EmailIsValid (Integer - 32bit) - (0) - False, Non-Zero Value for True |
| Field: | PhoneNumberTypeExternalReference (String) - Phone Number Type External Reference setup via Application |
| Field: | PhoneNumber (String) - Phone Should have Country Code and suggested to be unformatted - Raw |
| Field: | MobileCarrierExternalReference (String) - Mobile Carrier External Reference setup via Application |
| Field: | PhoneNumberIsValid (Integer - 32bit) - (0) - False, Non-Zero Value for True |
| Field: | IsEmployee (Integer - 32bit) Required - (0) - False, Non-Zero Value for True |
| Field: | DoNotCall (Integer - 32bit) Required - (0) - False, Non-Zero Value for True |
| Field: | DoNotMail (Integer - 32bit) Required - (0) - False, Non-Zero Value for True |
| Field: | DoNotEmail (Integer - 32bit) Required - (0) - False, Non-Zero Value for True |
| Field: | DoNotText (Integer - 32bit) Required - (0) - False, Non-Zero Value for True |
| Field: | CustomFieldPairs - Key / Value Pairs for Custom Fields (Keys = Custom Field External References setup via Application) |
| Type: | respEnrollProspect |
| Field: | ReturnCode (Integer) - (0) - Success / (Non-Zero) - Error (See Below) |
| Field: | MemberId (Integer - 32bit) - Kognitiv Loyalty Internal Unqiue Member Id |
| Field: | SavedAddressLine1 (String) - Formatted Address Line 1 that was Saved |
| Field: | SavedAddressLine2 (String) - Formatted Address Line 2 that was Saved |
| Field: | SavedAddressLine3 (String) - Formatted Address Line 3 that was Saved |
| Field: | SavedCity (String) - Formatted City that was Saved |
| Field: | SavedRegion (String) - Full Region Name Saved |
| Field: | SavedRegionAbbrev (String) - Region Abbrevation Saved |
| Field: | SavedPostalCode (String) - Formatted Postal Code that was Saved |
| Field: | SavedCountry (String) - Full Country Name Saved |
| Field: | SavedCountryAbbrev (String) - Country Abbrevation Saved |
| Field: | SavedEmailAddress (String) Formatted Email Address that was Saved |
| Field: | SavedPhoneNumber (String) Formatted Phone Number that was Saved |
| Additional Information | |
| Notes: | If any error is returned back, the entire enrollment has been reversed and discarded. |
| Error Codes | |
| Possible Return Codes: |
(0) - Sucess (1) - Undefined Error (Please Contact Support) (2) - Required Field Missing (100) - Invalid Security Token (101) - Invalid Permission for Method (307) - Invalid Email Type External Reference (308) - Invalid Phone Number Type External Reference (309) - Invalid Address Type External Reference (314) - Duplicate Email Address - Already in Use under another Member (315) - Duplicate Phone Number - Already in use under another Member (316) - Invalid Mobile Carrier External Reference (317) - Invalid Address Region for Country (803) - Error In Custom Field Collection (check External References and Value External References) (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. |