Get a member referral
get
/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
Request
Path Parameters
-
LoyMemberId(required): integer(int64)
The primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute.
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : loyMembers-MemberReferrals-item-response
Type:
Show Source
object-
AccntId: integer
(int64)
Title:
Account IDThe account identifier for the member's partner object of the member referred by current member. If the MemberType attribute is set to Company, then Oracle Loyalty Cloud populates AccountId. This attribute depends on the value of the MemberType attribute. There is no default value or limitation with this attribute. -
AccountPartyNumber: string
Title:
Account Party NumberRead Only:trueMaximum Length:30The account party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccountTypeCode: string
Title:
Account Type CodeRead Only:trueMaximum Length:30Default Value:ZCA_PROSPECTThe lookup type code of an account. The lookup type value is ZCA_ACCOUNT_TYPE. There is no default value or limitation associated with this attribute. -
AccrualLookupCode: string
Title:
Accrual Lookup CodeRead Only:trueMaximum Length:30The accrual lookup code is a read-only attribute that is dependent on AccrualLookupType. This attribute shows information about the referred member. This attribute gives additional information regarding AccrualTypeCode as a lookup code. There is no default value or limitation associated with this attribute. -
AccrualLookupType: string
Title:
Accrual Lookup TypeRead Only:trueMaximum Length:30The accrual lookup type attribute is a read-only attribute that shows information about the lookup type that is used to display AccrualTypeCode. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualMeaning: string
Title:
Accrual Type MeaningRead Only:trueMaximum Length:80The accrual meaning is a read-only attribute that shows information about the meaning text of the AccrualTypeCode attribute. This attribute shows information about the referred member. This attribute is dependent on AccrualTypeCode. There is no default value or limitation associated with this attribute. -
AccrualStartDate: string
(date-time)
Title:
Accrual Start DateThe date when the member starts accruing points from another member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHousehold: string
Title:
Accrual to Household MemberRead Only:trueMaximum Length:100The household to which an Individual member's points can be accrued. There is no default value, dependency, or limitation associated with this attribute. -
AccrualToHouseholdFlag: string
Title:
Accrual to HouseholdThis flag determines whether the accrual due to a transaction completed by a household member should be accrued to a member or to the household to which it belongs. There is no default value associated with this attribute. -
AccrualToMemId: integer
(int64)
Title:
Accrual-to Member IDThe identifier of the member to whose account the points are accrued for a corporate accrual. This attribute shows information about the referred member. This attribute value depends on the AccrualType attribute. There is no default value or limitation associated with this attribute. -
AccrualTypeCode: string
Title:
Accrual TypeMaximum Length:30The accrual type value, that is an LOV attribute which is based on FND lookups. This attribute shows information about the referred member. For the possible input values of AccrualTypeCode, the integrating user must first invoke the corresponding LOV resource path URL. For example: invoke lovResourcepath ../crmRestApi/resources/11.12.0.0/fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineOne: string
Title:
Individual Address Line 1Read Only:trueMaximum Length:240The first line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineThree: string
Title:
Individual Address Line 3Read Only:trueMaximum Length:240The third line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
AddressLineTwo: string
Title:
Individual Address Line 2Read Only:trueMaximum Length:240The second line in the address provided by a member contact or account while enrolling. There is no default value, dependency, or limitation associated with this attribute. -
City: string
Title:
Individual CityRead Only:trueMaximum Length:60The city of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ContactDateOfBirth: string
(date)
Title:
Date of BirthRead Only:trueThe date when the member was born. This attribute shows information from the corresponding contact used to create the current loyalty member. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactFirstName: string
Title:
First NameRead Only:trueMaximum Length:150The first name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactId: integer
(int64)
Title:
Contact IDThe contact identifier as specified in the Member Contacts object. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactLastName: string
Title:
Last NameRead Only:trueMaximum Length:150The last name of the member contact. A single Oracle Sales Cloud contact can be used to enroll into different loyalty programs. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ContactName: string
Title:
ContactMaximum Length:450The name of the contact associated with the member. This attribute shows information about the referred member. This attribute has the format of ContactFirstName ContactLastName. There is no default value, dependency, or limitation associated with this attribute. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The currency code used by the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CorpMemberNumber: string
Title:
Corporation Member NumberMaximum Length:15The corporate member number. If the current member is part of the company or corporate account, then Oracle Loyalty Cloud populates this field. This is an optional attribute which is introduced for future use. Oracle Loyalty Cloud does not currently use this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
Country: string
Title:
Individual CountryRead Only:trueMaximum Length:2The country of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
County: string
Title:
Individual CountyRead Only:trueMaximum Length:60The county of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user that creates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created DateRead Only:trueThe date when the member record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
CreationSource: string
Title:
Creation SourceThe information detailing the member creation source. This attribute value is set while creating a member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate method that is applied. This rate can apply to an individual or throughout the corporation. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The international currency code used by the loyalty member to complete transactions. International codes such as USD, INR,GBP are valid for this attribute. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
CurrencyDate: string
(date)
Title:
Currency DateThe date when the currency conversion rate is applied for a given currency code. There is no default value, dependency, or limitation associated with this attribute. -
DateOfBirth: string
(date)
Title:
Date of BirthRead Only:trueThe date when the member was born. This attribute shows information about the referred member. There is no default value, dependency, or limitation associated with this attribute. -
EmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the member. This attribute shows the read-only value of member's email address. While creating a loyalty member under a program, the MemberEmailAddress attribute gets written to the Contact information, which is used to recognize the contact. There is no default value, dependency, or limitation associated with this attribute. -
EnrollFlag: string
Title:
Enrollment RequiredThe Enroll flag is set when importing a member from a different system to an existing loyalty system. There is no default value or limitation associated with this attribute. -
FormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
GroupLookupCode: string
Title:
Group Lookup CodeRead Only:trueMaximum Length:30The FND lookup code value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
GroupLookupType: string
Title:
Group Lookup TypeRead Only:trueMaximum Length:30The FND lookup type value of the Member Group code. ORA_LOY_MEM_GRP is the lookup type for the Member Travel group. There is no default value, dependency, or limitation associated with this attribute. -
GroupMeaning: string
Title:
Member Group MeaningRead Only:trueMaximum Length:80The meaning of the current group that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_GRP, which is the lookup type for the Member Travel group. This attribute is dependent on the GroupLookupType attribute. There is no default value or limitation associated with this attribute. -
HHAddressOne: string
Title:
Household Address Line 1Read Only:trueMaximum Length:240Address entered in line one of a Household. -
HHAddressThree: string
Title:
Household Address Line 3Read Only:trueMaximum Length:240Address entered in line three of a Household. -
HHAddressTwo: string
Title:
Household Address Line 2Read Only:trueMaximum Length:240Address entered in line two of a Household. -
HHCity: string
Title:
Household CityRead Only:trueMaximum Length:60City of a Household. -
HHCountry: string
Title:
Household CountryRead Only:trueMaximum Length:2Country of a Household. -
HHCounty: string
Title:
Household CountyRead Only:trueMaximum Length:60County of a Household. -
HHPostalCode: string
Title:
Household Postal CodeRead Only:trueMaximum Length:60Postal Code of a Household. -
HHProvince: string
Title:
Household ProvinceRead Only:trueMaximum Length:60Province of a Household. -
HHState: string
Title:
Household StateRead Only:trueMaximum Length:60State of a Household. -
HouseholdMemberNumber: string
Title:
Household Member NumberThe member number of a household to be passed by a payload. This value should be a valid household enrolled already in the same loyalty program. There is no default value associated with this attribute. -
JobTitle: string
Title:
Job TitleThe job title of a contact which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
LastAccrTransactionDt: string
(date-time)
Title:
Last Accrual Transaction DateThe date when the last accrual transaction for the loyalty member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastRdmTransactionDt: string
(date-time)
Title:
Last Redemption Transaction DateThe last redemption transaction date. This attribute shows when the last redemption transaction by the member has occurred. There is no default value, dependency, or limitation associated with this attribute. -
LastTransactionProcedDt: string
(date-time)
Title:
Last Transaction Processed DateThe last transaction process date. This date shows when the last transaction was performed by the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Change DateRead Only:trueThe date when the member record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed ByRead Only:trueMaximum Length:64The user that updates the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login details of user that updated the member record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeAVal: number
Title:
Lifetime Payment Type A ValueThe member's life time point balance in internal point type A. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeBVal: number
Title:
Lifetime Payment Type B ValueThe member's life time point balance in internal point type B. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the higher watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeCVal: number
Title:
Lifetime Payment Type C ValueThe member's life time point balance in internal point type C. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeDVal: number
Title:
Lifetime Payment Type D ValueThe member's life time point balance in internal point type D. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeEVal: number
Title:
Lifetime Payment Type E ValueThe member's life time point balance in internal point type E. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeFVal: number
Title:
Lifetime Payment Type F ValueThe member's life time point balance in internal point type F. A program can have up to eight point types, internally referred to as Point type (A to H). Each of the point type has a life time point balance associated with it which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeGVal: number
Title:
Lifetime Payment Type G ValueThe member's life time point balance in internal point type G. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
LftmPointTypeHVal: number
Title:
Lifetime Payment Type H ValueThe member's life time point balance in internal point type H. A program can have up to eight point types, internally referred to as Point Type (A to H). Each point type has a life time point balance, which represents the high watermark of the member's point balance in that point type. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoyAccountName: string
Title:
Account NameThe loyalty member account name for the member's partner object. If the MemberTypeCode attribute is Company, then Oracle Loyalty Cloud populates the account name. This attribute depends on the value of the MemberTypeCode attribute. Oracle Loyalty Cloud populates the AccountName attribute based on the AccountId attribute. There is no default value or limitation associated with this attribute. -
LoyHouseholdName: string
Title:
Household NameThe household member name. If the MemberTypeCode attribute is set to Household, then this attribute shows membership information about the referred household. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member IDThe primary key of member referred by current loyMember resource. There is no default value, dependency, or limitation associated with this attribute. -
LoyProgramName: string
Title:
Program NameThe name of the loyalty program in which the member has been enrolled. This is a read-only attribute for the read-only child resource MemberReferrals of loyMembers. The LoyProgramName attribute is provided as input while creating the loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
LstTierChangeDt: string
(date-time)
Title:
Date of Member's Last Tier ChangeThe date when the member's tier change occurs. Oracle Loyalty Cloud updates this date when a member's tier changes. There is no default value, dependency, or limitation associated with this attribute. -
MemberClassCode: string
Title:
Member ClassMaximum Length:30The FND lookup code value of Member Class as an input of loyalty Members. The possible input values can be obtained by invoking the corresponding lovResourcePath URL: fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS. -
MemberClassMeaning: string
Title:
Member Class MeaningRead Only:trueMaximum Length:80The current class of the loyalty member. This is an extended lookup type attribute of type ORA_LOY_MEM_CLASS. There is no default value, dependency, or limitation associated with this attribute. -
MemberEmailAddress: string
Title:
Member Email AddressRead Only:trueMaximum Length:320The member's email address, which is provided as a input while creating loyalty Member record through REST API. This value will be used to create an Oracle Sales Cloud contact behind the scenes. There is no default value, dependency, or limitation associated with this attribute. -
MemberGrpCode: string
Title:
Member GroupMaximum Length:30The extended Lookup Type attribute of type ORA_LOY_MEM_GRP which shows information about the member's current group. There is no default value, dependency, or limitation associated with this attribute. -
MemberName: string
Title:
Member NameMaximum Length:100The name of the referred loyalty member, which can be provided as input while creating a loyalty member through the resource. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member NumberMaximum Length:30The member number of the referred loyalty member. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseCode: string
Title:
Member PhaseMaximum Length:30The lookup code value of the member phase used as a an input for loyalty Members. The integrating user must first invoke the lovResourcepath URL for possible input values. The corresponding lovResourcePath URL is ?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MemberPhaseMeaning: string
Title:
Member Phase MeaningRead Only:trueMaximum Length:80The current phase for the that the loyalty member. This attribute has an extended lookup associated with ORA_LOY_MEM_PHASE. There is no default value, dependency, or limitation associated with this attribute. -
MembershipSchemeId: integer
(int64)
Title:
Membership Scheme IDThe unique reference to the member scheme, if any, chosen by the user while enrolling into the loyalty program. The member scheme can be a paid or free scheme. For example, a 6 months free membership, or a 1 Year $5 paid membership, and so on. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeCode: string
Title:
TypeMaximum Length:30Default Value:ORA_MEM_TYPE_INDIVIDUALThe member type, which is provided as an input attribute while creating a loyalty member. To know the possible input values, the user must invoke the corresponding lovResourcePath URL ....fndStaticLookups?finder=LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE. There is no default value, dependency, or limitation associated with this attribute. -
MemberTypeMeaning: string
Title:
Member Type MeaningRead Only:trueMaximum Length:80The meaning of the current type that the referred loyalty member is in. This has an extended lookup associated with ORA_LOY_MEM_TYPE, which is the lookup type for the Member Travel group. This attribute is dependent on the MemberLookupType attribute. There is no default value or limitation associated with this attribute. -
MobileNumber: string
Title:
Mobile NumberRead Only:trueMaximum Length:40The mobile number of the member. This attribute can be provided as input when enrolling a loyalty member into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressOne: string
Title:
Company Address Line 1Read Only:trueMaximum Length:240Address of a Account entered in line One. -
OrganizationAddressThree: string
Title:
Company Address Line 3Read Only:trueMaximum Length:240The third line of the address provided while enrolling a member as an organization in a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationAddressTwo: string
Title:
Company Address Line 2Read Only:trueMaximum Length:240Address of an Account entered in line two. -
OrganizationCity: string
Title:
Company CityRead Only:trueMaximum Length:60The city part of the address provided by an organization while enrolling a member as an organization in loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
OrganizationCountry: string
Title:
Company CountryRead Only:trueMaximum Length:2Country of an Account. -
OrganizationCounty: string
Title:
Company CountyRead Only:trueMaximum Length:60County of an Account. -
OrganizationPostalCode: string
Title:
Company Postal CodeRead Only:trueMaximum Length:60Postal Code of an Account. -
OrganizationProvince: string
Title:
Company ProvinceRead Only:trueMaximum Length:60Province of an Account. -
OrganizationState: string
Title:
Company StateRead Only:trueMaximum Length:60State of an Account. -
OrgGroupId: integer
(int64)
Title:
Organization Group IDThe organization group identifier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute. -
OrgGroupPartyNumber: string
Title:
Household Party NumberRead Only:trueMaximum Length:30The organization group party number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ParentMember: string
Title:
ParentMaximum Length:1Default Value:NThe parent member where the loyalty member is either a household or an individual, but is also a corporate member. There is no default value, dependency, or limitation associated with this attribute. -
PartyName: string
Title:
Contact Party NameMaximum Length:360The loyalty partner name as an alternative identifier. Oracle Loyalty Cloud creates this identifier when a loyalty membership is created through a partner as a reference. There is no default value, dependency, or limitation associated with this attribute. -
PartyNumber: string
Title:
Registry IDRead Only:trueMaximum Length:30The party number of the contact associated with the loyalty member. -
PersonFirstName: string
Title:
Primary Contact First NameRead Only:trueMaximum Length:150The first name of the member contact in the context of referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same FirstName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonLastName: string
Title:
Primary Contact Last NameRead Only:trueMaximum Length:150The last name of the member contact in the context of the referred member. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a loyalty member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PersonName: string
Title:
Person NameMaximum Length:450The full name of the member contact. The Contact object in Oracle Sales Cloud stores the member's first name, last name, and middle name. This same LastName attribute can be used while enrolling a member to a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PhoneNumber: string
Title:
PhoneRead Only:trueMaximum Length:40The phone number of the member. This is one of the Member Contact fields which can be used while enrolling a loyalty member in a program. There is no default value, dependency, or limitation associated with this attribute. -
Points: string
Title:
PointsRead Only:trueMaximum Length:255Default Value:0The point balance. This attribute is the numeric value of the point balance of the loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeAVal: number
Title:
Point Type A ValueDefault Value:0The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeBVal: number
Title:
Point Type B ValueDefault Value:0The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeCVal: number
Title:
Point Type C ValueDefault Value:0The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeDVal: number
Title:
Point Type D ValueDefault Value:0The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeEVal: number
Title:
Point Type E ValueDefault Value:0The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeFVal: number
Title:
Point Type F ValueDefault Value:0The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeGVal: number
Title:
Point Type G ValueDefault Value:0The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PointTypeHVal: number
Title:
Point Type H ValueDefault Value:0The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute. -
PostalCode: string
Title:
Individual Postal CodeRead Only:trueMaximum Length:60The postal code of the contact or account or household address, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PrConId: integer
(int64)
Title:
Primary Contact IDThe partner contact identifier. This value can be provided as an input while creating a loyalty member through the resource and when Oracle Loyalty Cloud enrols the corresponding contact as a member in the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
PreviousTierName: string
Title:
Previous Tier NameRead Only:trueThe previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute. -
ProgramNumber: string
Title:
Program NumberMaximum Length:30The program number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
Province: string
Title:
Individual ProvinceRead Only:trueMaximum Length:60The province of the contact or account or household, which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
RealTimeBonusFlag: boolean
Title:
Real Time BonusMaximum Length:1Default Value:falseThe real time bonus flag. If this flag is set to Y, then on member enrollment, it processes enrollment and referral bonus transactions in real time. Otherwise, it will create an enrollment bonus and referral bonus transaction and set the status to Queued for the batch engine to pick and process. There is no default value, dependency, or limitation associated with this attribute. -
ReferConId: integer
(int64)
Title:
Referring Member Contact IDRead Only:trueThe primary contact identifier of referral member. This value is shown as additional information regarding the referred member. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNam: string
Title:
Referred ByMaximum Length:100The member identifier of the referring member name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByName: string
Title:
Referred ByThe member identifier by name who has referred the current member to the loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
ReferredByNumber: string
Title:
Referred by NumberMaximum Length:30The member number of the member who has referred the current member to the loyalty program. This value is input by the user and is validated against the existing member record in Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipId: integer
(int64)
Title:
Relationship IDThe relationship identifier which shows the relationship between loyalty members. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record IdentifierRead Only:trueThe relationship record identifier that shows the relationship of the member between other loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
RelationshipType: string
Title:
Relationship TypeRead Only:trueMaximum Length:30The relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
reltype: string
Title:
Relationship TypeThe relationship type showing the type of relation between loyalty members. For example, there might be a relationship between an organization and a member. There is no default value, dependency, or limitation associated with this attribute. -
StartDate: string
(date-time)
Title:
Joining DateThe date when the membership in the loyalty program starts. There is no default value, dependency, or limitation associated with this attribute. -
State: string
Title:
StateRead Only:trueMaximum Length:60The state code of the contact or account or household, which is provided by member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute. -
Status: string
Title:
Status MeaningMaximum Length:80The member status meaning of referred loyalty member which is a read-only value based on the Status code attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:ORA_MEM_STATUS_ACTIVEThe status code of the loyalty member, which is a read-only value based on the Status attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_STATUS lookup. There is no default value or limitation associated with this attribute. -
SuppressCall: string
Title:
Suppress CallThe attribute indicates that the member does not want to receive any calls pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressCallFlag: boolean
Title:
Block Member Call ContactMaximum Length:1Default Value:falseBlock Member Call Contact. -
SuppressEmail: string
Title:
Suppress EmailThe attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressEmailFlag: boolean
Title:
Block Member Email ContactMaximum Length:1Default Value:falseBlock Member Email Contact. -
SuppressFax: string
Title:
Suppress FaxThe attribute indicates that the member does not want to receive any fax pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressFaxFlag: boolean
Title:
Block Member Fax ContactMaximum Length:1Default Value:falseBlock Member Fax Contact. -
SuppressMail: string
Title:
Suppress MailThe attribute indicates that the member does not want to receive any mail pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressMailFlag: boolean
Title:
Block Member Mail ContactMaximum Length:1Default Value:falseBlock Member Mail Contact. -
SuppressSMS: string
Title:
Suppress SMSThe attribute indicates that the member does not want to receive any SMS pertaining to the ongoing loyalty promotions and related updates. The default value is No. There is no dependency or limitation associated with this attribute. -
SuppressSMSFlag: boolean
Title:
Block Member SMS ContactMaximum Length:1Default Value:falseBlock Member SMS Contact. -
SurvMemNumber: string
Title:
Surviving Member NumberMaximum Length:30The surviving member number associated with the referred member. There is no default value, dependency, or limitation associated with this attribute. -
TierName: string
Title:
TierRead Only:trueMaximum Length:255The tier name of the current tier of the loyalty member. The tier calculation is done by the Oracle Loyalty Cloud engine. This attribute value is set by the Oracle Loyalty Cloud engine when performing the tier assessment of the loyalty member based on the qualifying point balance of the member. There is no default value, dependency, or limitation associated with this attribute. -
URL: string
The member URL which is provided by the member while enrolling into a loyalty program. There is no default value, dependency, or limitation associated with this attribute.
-
ValLifeScore: string
Title:
Lifetime Value ScoreMaximum Length:50The life time value score of the loyalty member as the highest watermark value. There is no default value, dependency, or limitation associated with this attribute. -
WorkPhoneNumber: string
Title:
PhoneRead Only:trueMaximum Length:40The work phone number of the referred member. The WorkPhoneNumber attribute is another contact related attribute which shows the secondary formatted phone number if the primary phone number Is not available. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- AccountType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ACCOUNT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AccountTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ContactLOV
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list of contacts for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: PartyName; Target Attribute: PartyName
- Display Attribute: PartyName
- MemberAccrualType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_ACCRU_TYPE
The list of accrual types for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: AccrualTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberClass
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CLASS%2CBindLookupCode%3D{MemberClassCode}
The list of classes for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberClassCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberGroup
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_GRP%2CBindLookupCode%3D{MemberGrpCode}
The list of groups for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberGrpCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberPhase
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_PHASE%2CBindLookupCode%3D{MemberPhaseCode}
The list of phases for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberPhaseCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberType
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_TYPE
The list of types for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: MemberTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonLOV
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe list member names.
The following properties are defined on the LOV link relation:- Source Attribute: ContactName; Target Attribute: PersonName
- Display Attribute: PersonName
- RatedCurrenciesVO
-
The list of currencies for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- ReferredByLOV
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe list of referrals for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: ReferredByNam; Target Attribute: MemberName
- Display Attribute: MemberName
- ReferredByMemberVA
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe list of referrals for a loyalty member.
The following properties are defined on the LOV link relation:- Source Attribute: ReferredByNumber; Target Attribute: MemberNumber
- Display Attribute: MemberNumber, LoyMemberId
- ReferredbyUILOV
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersThe following properties are defined on the LOV link relation:
- Source Attribute: ReferredByName; Target Attribute: MemberName
- Display Attribute: MemberName