1. REST API for Oracle Loyalty Cloud
  2. Tasks
  3. (Deprecated) Loyalty Member Enrollments

Get a loyalty promotion to which a member is enrolled (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/{LoyPromomemId}

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : loyaltyMemberEnrollments-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top

Examples

This example shows how to check the details for the promotions to which a member is enrolled..

Use GET with the following URI syntax to check the details for the promotions to which a member is enrolled:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
content-encoding -gzip
content-length -711
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Mon, 06 Nov 2017 07:31:20 GMT
link -<http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions>;rel="self";kind="collection";name="MemberPromotions"
location -
rest-framework-version -1
x-oracle-dms-ecid -1af7a1f9b5f2eb0a:-7382507b:15f7743979e:-8000-0000000000118b5f
x-powered-by -Servlet/2.5 JSP/2.1

Example of Response Body

{
    "items": [
        {
            "EnrollmentEnd": "2017-09-28T00:00:00-07:00",
            "EnrollmentStart": "2017-09-27T00:00:00-07:00",
            "LoyPromomemId": 300100091691746,
            "ObjectVersionNumber": 2,
            "Active": "Y",
            "MemberNumber": "300100090905743",
            "PromotionName": "zaheernextmonthenroll",
            "PromotionType": "Accrual",
            "PromotionSubType": "Manual Credit",
            "links": [
                {
                    "rel": "self",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions/300100091691746",
                    "name": "MemberPromotions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions/300100091691746",
                    "name": "MemberPromotions",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743",
                    "name": "loyaltyMembers",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions/300100091691746/lov/PromotionPVO1",
                    "name": "PromotionPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions/300100091691746/lov/MemberPVO1",
                    "name": "MemberPVO1",
                    "kind": "collection"
                }
            ]
        }
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberPromotions",
            "name": "MemberPromotions",
            "kind": "collection"
        }
    ]
}
Back to Top