Get all loyalty promotions to which a member is enrolled
get
/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a member enrolled in a promotion with a specified promotion number.
Finder Variables:- LoyPromomemId; integer; The promotion member number.
- PrimaryKey: Finds a member enrolled in a promotion with a specified promotion number.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The details of who created the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud generates this attribute value during the creation of a new member enrollment into an enrollable promotion record. There is no default value, dependency, or limitation associated with this attribute.
- CreationDate; string; The date when the member enrollment into an enrollable promotion was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member enrollment under an enrollable promotion. There is no default value, dependency, or limitation associated with this attribute.
- EligFlg; string; Indicates if member is eligible or enrolled
- EnrollmentEnd; string; The date when the promotion enrollment ends. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.
- EnrollmentStart; string; The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.
- IncentiveChoice; string; The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be set up for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute.
- LastUpdateDate; string; The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the enrollment. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdateLogin; string; The session login details associated to the user who last updated the row. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment in to enrollable Promotion take place. There is no default value, dependency, or limitation associated with this attribute.
- LastUpdatedBy; string; The user that updates the member enrollment into an enrollable Promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable promotion in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
- LoyPromomemId; integer; The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
- MemberId; integer; The primary key identifier of the loyalty member who is currently enrolled in to an enrollable promotion.
- OfferNum; string; Offer number
- PromoMemNumber; string; The public unique identifier of the member promotion enrolled object, which is unique to a given enrollement for a given time period. There is no default value, dependency, or limitation associated with this attribute.
- PromotionName; string; The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute.
- SubTypeCode; string; The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.
- SubTypeCodeMeaning; string; The subtype meaning of the promotion, which is dependent on the promotion type. There is no default value, dependency, or limitation associated with this attribute.
- TypeCode; string; The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.
- TypeCodeMeaning; string; The type meaning of the promotion which is based on the promotion type code. There is no default value, dependency, or limitation associated with this attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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(required):
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(required):
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 : loyaltyMemberPromotionEnrollments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : loyaltyMemberPromotionEnrollments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The details of who created the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud generates this attribute value during the creation of a new member enrollment into an enrollable promotion record. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the member enrollment into an enrollable promotion was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member enrollment under an enrollable promotion. There is no default value, dependency, or limitation associated with this attribute. -
EligFlg: string
Title:
Eligibility
Maximum Length:1
Default Value:N
Indicates if member is eligible or enrolled -
EnrollmentEnd: string
(date-time)
Title:
Enrollment End Date
The date when the promotion enrollment ends. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Enrollment Start Date
The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
IncentiveChoice: string
Title:
Incentive Choice
The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be set up for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the enrollment. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user that updates the member enrollment into an enrollable Promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable promotion in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login details associated to the user who last updated the row. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment in to enrollable Promotion take place. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key identifier of the loyalty member who is currently enrolled in to an enrollable promotion. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
OfferNum: string
Title:
Offer Number
Maximum Length:30
Offer number -
PromoMemNumber: string
Title:
Promotion Member Number
The public unique identifier of the member promotion enrolled object, which is unique to a given enrollement for a given time period. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion Name
The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion Number
Read Only:true
Maximum Length:30
The loyalty promotion number which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Promotion Sub Type
Read Only:true
Maximum Length:30
The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCodeMeaning: string
Title:
Promotion Sub Type Meaning
Read Only:true
Maximum Length:80
The subtype meaning of the promotion, which is dependent on the promotion type. There is no default value, dependency, or limitation associated with this attribute. -
TypeCode: string
Title:
Promotion Type
Read Only:true
Maximum Length:30
The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
TypeCodeMeaning: string
Title:
Promotion Type Meaning
Read Only:true
Maximum Length:80
The type meaning of the promotion which is based on the promotion type code. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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
- setIncentiveChoiceSaved
-
Operation: /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/action/setIncentiveChoiceSavedThis action is not an Oracle Loyalty Cloud action. It is recommended that you do not add this action to your REST applications.
Examples
This example shows how to retrieve all member promotion enrollments in the loyalty program.
Use GET with the following URI syntax to retrieve all member promotion enrollments:
https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments
Example of Response Header
cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -762
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Mon, 20 Aug 2018 18:20:42 GMT
keep-alive -timeout=61, max=100
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments>;rel="self";kind="collection";name="loyaltyMemberPromotionEnrollments"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005Sy7radhvEoIILIqL6if0001wh0000qx
Example of Response Body
{
"items": [
{
"LoyPromomemId": 100100058401527,
"MemberNumber": "300100129319639",
"PromotionName": "MyPromotionEnrollment",
"EnrollmentStart": "2018-08-08T12:08:56.235+00:00",
"EnrollmentEnd": "2019-08-06T12:08:56.235+00:00",
"CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
"CreationDate": "2018-08-09T19:25:18.438+00:00",
"LastUpdateDate": "2018-08-09T19:25:18.438+00:00",
"LastUpdateLogin": "LOYALTY_PROGRAM_ADMINISTRATOR",
"LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
"MemberId": 300100129319638,
"TypeCode": "ORA_TXN_ACC",
"SubTypeCode": "ORA_ACC_PROD",
"IncentiveChoice": "5000 bonus points",
"IsMergeSurvivor": null,
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/100100058401527",
"name": "loyaltyMemberPromotionEnrollments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/100100058401527",
"name": "loyaltyMemberPromotionEnrollments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/100100058401527/lov/PromotionVO1",
"name": "PromotionVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/100100058401527/lov/PromotionIncentiveChoiceVO1",
"name": "PromotionIncentiveChoiceVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/100100058401527/lov/MemberNumberVA",
"name": "MemberNumberVA",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments",
"name": "loyaltyMemberPromotionEnrollments",
"kind": "collection"
}
]
}