Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

LoyaltyMemberEnrolment


Use this Web service with the Siebel Loyalty Application to perform the following operations for a member:

  • Enrolling a member into the selected Loyalty Program
  • Updating member data
  • Enrollment Payment processing for the selected member
  • Generating specified number of pre-allotted memberships into the selected Loyalty Program.

LoyaltyMemberEnrolment Operations

For a list of operations associated with this Web service, see Table 269.

Table 269. LoyaltyMemberEnrolment Operations
Name
Description

MemberEnrollment

Enrolls a member into the specified loyalty program and returns the generated Member number, along with the Simulated prices for enrollment, if any. In case of any error, it sends the member data along with the error message or messages.

If the Enrollment entails a payment, then this Web service method enrolls the member into Payment Pending status. If there is no Payment required, then the member directly goes into the Active status.

MemberUpdate

Used to update member details.

If there is payment involved with the membership scheme, and if the membership is designated as Pre-Allotted, then this Web service updates the member details and returns the list of simulated prices along with the list of error messages occurred during the member update.

EnrollmentPaymentProcessing

Used to process the enrollment payment for the selected member, who is in the Payment Pending status.

If the payment processing is successful, then the member status becomes Active, otherwise the status will remain in Payment Pending.

This Web service returns the list of error messages occurred during the payment processing.

GeneratePreallottedMemberships

Used to generate the specified number of membership numbers for the given Loyalty program. The status of all these memberships.

EnrolContactAsMember

Creates a Loyalty membership from an existing Siebel contact from social networks. You can also view membership details and contact details that were captured from the attributes of the social profile.

Request Message Description: MemberEnrollment

For a description of this request message, see Table 270.

Table 270. Request Message Description: MemberEnrollment
Node
Description
Type

Siebel Message

Hierarchy of the Member details. Uses the integration object LOY Member.

Required Input:

  • Action Type must be Enrollment.
  • Program Id.
  • Membership Scheme Id.
  • Member Type.
  • Contact Details.
  • Account, Household details based on the member type.

Hierarchy (Integration Object : LOY Member).

Response Message Description: MemberEnrollment

For a description of this response message, see Table 271.

Table 271. Response Message Description: MemberEnrollment
Node
Description
Type

Siebel Message

Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages.

If the member is created successfully and payment is involved for the membership scheme, then the property set contains the enrolment simulated price lists.

Hierarchy (Integration Object : LOY Member).

Request Message Description: MemberUpdate

For a description of this request message, see Table 272.

Table 272. Request Message Description: MemberUpdate
Node
Description
Type

Siebel Message

Hierarchy of the Member details. Uses the integration object LOY Member.

Required Input:

  • Action type must be 'Update'.
  • Member Number.

Hierarchy (Integration Object : LOY Member)

Response Message Description: MemberUpdate

For a description of this response message, see Table 273.

Table 273. Response Message Description: MemberUpdate
Node
Description
Type

Siebel Message

Hierarchy of the Member details. If there is any error in the processing of the member details, then the property set returns the entire member details along with the error messages.

If the member has a status of Prealloted and the supplied membership scheme has payment, then the property set contains the enrolment simulated price lists.

Hierarchy

Request Message Description: EnrolmentPaymentProcessing

For a description of this request message, see Table 274.

Table 274. Request Message Description: EnrolmentPaymentProcessing
Node
Description
Type

Member Number

Member number.

String

Credit Card Number

Credit card number.

String

Card Holder Name

Name of the credit card holder.

String

Credit Card Type

Credit Card Type such as Visa, MasterCard, and so on.

String

Expiration Month

Expiration Month of the credit card.

String

Expiration Year

Expiration year of the credit card.

String

CVV Number

CVV number of the credit card.

String

Billing Address

Primary billing address of the member.

String

Billing Address2

Secondary billing address of the member.

String

Billing City

Billing address city.

String

Billing State

Billing address state.

String

Billing Country

Billing address country.

String

Billing ZIP Code

Billing address ZIP code.

String

Amount

Simulated Amount.

Number

Base Pay

Base price of the membership plan.

Number

Currency Code

Currency Code.

String

Response Message Description: EnrolmentPaymentProcessing

For a description of this response message, see Table 275.

Table 275. Response Message Description: EnrolmentPaymentProcessing
Node
Description
Type

MemberNumber

Member Number.

String

Status

Status of the Member.

String

Payment Errors

The list of error messages occurred during the enrolment payment processing.

Hierarchy (Integration Object: LOY ENR Payment Errors)

Request Message Description: GeneratePreAllottedMemberships

For a description of this request message, see Table 276.

Table 276. Request Message Description: GeneratePreAllottedMemberships
Node
Description
Type

Program Id

Program ID.

String

Number of Members

The total number of pre-allotted memberships to be generated.

Number

Response Message Description: GeneratePreAllottedMemberships

For a description of this response message, see Table 277.

Table 277. Response Message Description: GeneratePreAllottedMemberships
Node
Description
Type

MemberNumbers

The hierarchy of the list of membership numbers generated in Pre-allotted status.

Hierarchy (Integration Object: LOY Preallotted Member)

Request Message Description: EnrolContactAsMember

For a description of this request message, see Table 278.

Table 278. Request Message Description: EnrolContactAsMember
Node
Description
Type

Account Id

Optional. The ID of the account being enrolled.

String

Accrual Type

Optional. The accrual type.

String

Contact Id

Required. The primary contact ID of the member being enrolled.

String

Enrollment Channel

Optional. The enrollment channel. Valid values are drawn from the LOV LOY_TXN_CHNNL_CD table.

String

Household Id

Optional. The existing household ID.

String

Member Type

Optional. The member type.

String

Membership Scheme Id

Optional. Membership plan corresponding to the member type.

String

Name

Optional. The member name.

String

Program Id

Optional. The existing program to which the member should be enrolled.

String

Referred By Id

Optional. The existing Referred by Member ID.

String

Response Message Description: EnrolContactAsMember

For a description of this response message, see Table 279.

Table 279. Response Message Description: EnrolContactAsMember
Node
Description
Type

Siebel Message

Hierarchy of the Contact Member details. Uses the integration object LOY Member.

Integration Object

Example Package for LoyaltyMemberEnrolment

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request

See the following file to view the sample code:

...\LoyaltyMemberEnrolment\Request.xml

Response

See the following file to view the sample code:

...\LoyaltyMemberEnrolment\Response.xml

Interface Description (WSDL) for LoyaltyMemberEnrolment

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LoyaltyMemberEnrolment\WSDL

Siebel CRM Web Services Reference Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.