Application
|
RCE
|
Target Name Space
|
http://www.oracle.com/retail/integration/base/bo/LoyAcctDesc/v1
|
Version
|
1.0
|
Description
|
|
XSD Structure
|
|
|
XML-Schema Name:LoyAcctDesc
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for LoyAcctDesc in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
account_id |
varchar232 |
0 |
1 |
The id of the loyalty account as maintained by, and usually generated by, the loyalty system of record.
This element is not required when using LoyAcctDesc as a parameter for creating a loyalty account.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
program_id |
varchar232 |
0 |
1 |
The id of the loyalty program that the account should be created for (i.e. for which the customer is enrolling into).
Merchants may have more than one loyalty program per line-of-business. They may have variable durations and/or
membership costs. May also be referred to a a scheme id.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
start_date |
xs:dateTime |
0 |
1 |
The date the member agreed to start participating in the loyalty program.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
referred_by_member_number |
varchar232 |
0 |
1 |
The loyalty member number of the member that referred this customer.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
ProgramLevel
|
*
|
0
|
1
|
The level the member has attained within the loyalty program's scheme.
|
|
|
|
|
|
|
PointsBalance
|
*
|
0
|
1
|
The breakdown of all point totals currently accrued for this account.
|
|
|
|
|
|
|
Awards
|
*
|
0
|
1
|
The list of awards associated with the account that may be used by its members.
|
|
|
|
|
|
|
LoyaltyMember
|
*
|
0
|
99
|
If any customers have been associated with this account as a loyalty member,
those customers should be listed here. When creating a loyalty account,
there should be at least one member specified, depending on system requirements.
Limited to 99 to prevent XML overflow.
|
|
|
|
|
|
|
LoyaltyCard
|
*
|
0
|
99
|
Zero to many cards that have been issued for this account are listed here.
When creating a loyalty account, some card information may be required,
such as prefix and series sequence. Check with the service provider system
documentation for requirements.
Limited to 99 to prevent XML overflow.
|
|
|
|
|
|
|
|
|
XML-Schema Name:ProgramLevel
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for ProgramLevel in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
level_id |
number2 |
0 |
1 |
The id of the loyalty program level.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
level_name |
varchar232 |
0 |
1 |
The name of the loyalty program level.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:PointsBalance
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for PointsBalance in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
earned |
number9 |
0 |
1 |
This includes all the points currently earned (and unused) by the members of this account
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
escrow |
number9 |
0 |
1 |
All the points issued but not yet earned or ready to be converted to an award.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
bonus |
number9 |
0 |
1 |
The amount of points that have been issued to a member as a bonus.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
ytd |
number9 |
0 |
1 |
The amount of points that have been earned since the beginning of the year.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
ltd |
number9 |
0 |
1 |
The amount of points that have been earned since the creation (lifetime) of the loyalty account.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:Awards
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for Awards in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
Coupon
|
*
|
0
|
99
|
|
|
|
|
|
|
|
|
|
XML-Schema Name:Coupon
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for Coupon in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
id |
varchar232 |
1 |
1 |
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
amount |
number20_4 |
1 |
1 |
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
currency_code |
varchar23 |
0 |
1 |
The ISO code of the currency in which the monetary amount of the coupon was awarded.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
expiration_date |
xs:dateTime |
0 |
1 |
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
|
|
XML-Schema Name:LoyaltyMember
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for LoyaltyMember in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
cst:CustomerRef
|
*
|
1
|
1
|
The customer id for this member, as given by the customer system of record, can be specified here.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|
XML-Schema Name:LoyaltyCard
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for LoyaltyCard in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
card_prefix |
varchar25 |
0 |
1 |
The prefix, a 5-digit sequence, used on the card for the card number.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
card_series_seq |
varchar22 |
0 |
1 |
The sequence number, a 2-digit sequence, that indicates the card series of the card.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
card_number |
varchar232 |
0 |
1 |
The physical card number, either printed, magnetically imprinted, or encoded and used by the member for identification.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
serial_number |
varchar232 |
0 |
1 |
A unique identifier for the physical card that identifies a single card instance.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
auth_data |
varchar264 |
0 |
1 |
The password or PIN number required to authenticate the customer as the correct loyalty member.
|
Fill application table name. |
Fill table column name. |
RIB or/and RSB |
Fill column length. |
Yes |
Fill this description. |
LoyaltyMember
|
*
|
0
|
1
|
If there is a primary customer associated with this card, the member number, i.e. customer id, can be specified here.
This customer should also exist in the LoyaltyMember element of the LoyAcctDesc.
|
|
|
|
|
|
|
|
|
XML-Schema Name:LoyaltyMember
|
Version:16.0.21
|
Return to Top
|
XSD Element Name |
XSD Element Data Type |
XSD Min Occurs |
XSD Max Occurs |
XSD Element Description |
Mapping for LoyaltyMember in RCE application. |
RCE's Table Name |
RCE's Column Name |
Integration API(RIB or/and RSB or/and RSL) |
RCE's Column Length |
Is Column Required in RCE's API? |
RCE's API Description |
cst:CustomerRef
|
*
|
1
|
1
|
The customer id for this member, as given by the customer system of record, can be specified here.
|
NA
|
NA
|
NA
|
NA
|
NA
|
NA
|
|
|