Get all loyalty promotions to which a member is enrolled (Deprecated)
get
/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments
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 member number.
Finder Variables:- LoyPromomemId; integer; The promotion member number.
- PrimaryKey: Finds a member enrolled in a promotion with a specified promotion member 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:- Active; string; The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
- EnrollmentEnd; string; The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.
- EnrollmentStart; string; The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.
- LoyPromomemId; integer; The promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. There is no default value, dependency, or limitation associated with this attribute.
- ObjectVersionNumber; integer; The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
- PromotionSubType; string; The promotion sub type details, which are based on the Promotion Type attribute. The accepted values are Manual Credit, Product, and so on. There is no default value, dependency, or limitation associated with this attribute.
- PromotionType; string; The type of promotion to which the member is enrolled. The accepted values are Accrual, Redemption, or Tier. 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 : loyaltyMemberEnrollments
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 : loyaltyMemberEnrollments-item-response
Type:
Show Source
object
-
Active: string
Title:
Active
Read Only:true
Maximum Length:1
The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute. -
EnrollmentEnd: string
(date-time)
Title:
Member Enrollment End Date in Promotion.
The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Promotion Enrollment Date
The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value 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 promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. There is no default value, dependency, or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
The unique identifier of a loyalty member. This attribute specifies the member that is being enrolled into the promotion. There is no default value, dependency, or limitation associated with this attribute. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion Name
The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute. -
PromotionSubType: string
Read Only:
true
The promotion sub type details, which are based on the Promotion Type attribute. The accepted values are Manual Credit, Product, and so on. There is no default value, dependency, or limitation associated with this attribute. -
PromotionType: string
Read Only:
true
The type of promotion to which the member is enrolled. The accepted values are Accrual, Redemption, or Tier. 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.
Examples
This example shows how to retrieve all membership enrollments in the loyalty program.
Use GET with the following URI syntax to retrieve all membership enrollments:
https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments
Example of Response Header
cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -1999
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Wed, 28 Mar 2018 20:13:35 GMT
keep-alive -timeout=61, max=100
link -<https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments>;rel="self";kind="collection";name="loyaltyMemberEnrollments"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005Q7u^LnidEoIILIqL6if0007EH00072^
Example of Response Body
{
"items": [
{
"EnrollmentEnd": "2019-03-27T01:00:00+00:00",
"EnrollmentStart": "2018-03-24T01:00:00+00:00",
"LoyPromomemId": 300100125623476,
"ObjectVersionNumber": 1,
"Active": "Y",
"MemberNumber": "300100125644195",
"PromotionName": "Auto93068970002En",
"PromotionType": "Accrual",
"PromotionSubType": "Product",
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125623476",
"name": "loyaltyMemberEnrollments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125623476",
"name": "loyaltyMemberEnrollments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125623476/lov/PromotionPVO1",
"name": "PromotionPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125623476/lov/MemberPVO1",
"name": "MemberPVO1",
"kind": "collection"
}
]
},
{
"EnrollmentEnd": null,
"EnrollmentStart": "2018-04-05T06:53:05.018+00:00",
"LoyPromomemId": 300100125673218,
"ObjectVersionNumber": 1,
"Active": "Y",
"MemberNumber": "300100125673189",
"PromotionName": "Auto4be44951849En",
"PromotionType": "Accrual",
"PromotionSubType": "Product",
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125673218",
"name": "loyaltyMemberEnrollments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125673218",
"name": "loyaltyMemberEnrollments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125673218/lov/PromotionPVO1",
"name": "PromotionPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125673218/lov/MemberPVO1",
"name": "MemberPVO1",
"kind": "collection"
}
]
},.
.
.
{
"EnrollmentEnd": "2019-03-27T00:25:38+00:00",
"EnrollmentStart": "2018-03-24T00:25:38.459+00:00",
"LoyPromomemId": 300100125608625,
"ObjectVersionNumber": 1,
"Active": "Y",
"MemberNumber": "300100125608443",
"PromotionName": "Auto12f35972700En",
"PromotionType": "Accrual",
"PromotionSubType": "Product",
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125608625",
"name": "loyaltyMemberEnrollments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125608625",
"name": "loyaltyMemberEnrollments",
"kind": "item"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125608625/lov/PromotionPVO1",
"name": "PromotionPVO1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100125608625/lov/MemberPVO1",
"name": "MemberPVO1",
"kind": "collection"
}
]
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments",
"name": "loyaltyMemberEnrollments",
"kind": "collection"
}
]
}