Get all tiers (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers

Request

Path Parameters
  • The member number. This attribute is an alternative identifier for a member and is displayed in the UI. 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
  • 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 tier with specified member tier identifier, tier class identifier and tier identifier.
      Finder Variables:
      • LoyTierClsId; integer; The tier class identifier.
      • LoyTierId; integer; The tier identifier.
      • MemTierId; integer; The member tier identifier.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 active status of the member tier, which shows the current active tier to which a member belongs. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
    • ChangedBy; string; The user identifier of the user that made the change to the current member tier represented by this record. There is no default value, dependency, or limitation associated with this attribute.
    • CurrentTier; string; The current tier of the member, which displays the information about which tier the member currently belongs to. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers that are related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
    • EndDate; string; The date when the member tier ends. The member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute.
    • LoyTierClsId; integer; The tier class identifier of a member tier, which is a reference identifier that uniquely identifies a member tier class. It provides information about which tier class the current member tier record belongs. There is no default value, dependency, or limitation associated with this attribute.
    • LoyTierId; integer; The tier identifier of the member tier which is the unique identifier to identify a loyalty tier. For example, if a member currently belongs to the Silver tier, then to identify the Silver tier, Oracle Loyalty Cloud uses the LoyTierId attribute as an internal Identifier. There is no default value, dependency, or limitation associated with this attribute.
    • MemTierId; integer; The member tier identifier. The Internal identifier for the member tier for which the member tier record exists. For example, if the member has a current tier of Silver, then the record in the Member Tier object has an entry for Member Id with MemberTierId as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.
    • MemberId; integer; The member reference identifier for the current member tier child records, which provides information about the current member tier to which the member belongs. There is no default value, dependency, or limitation associated with this attribute.
    • Nexttierid; integer; The identifier of the possible tier to which the member can upgrade, while considering the number of qualifying points that are required to achieve that tier. There is no default value, dependency, or limitation associated with this attribute.
    • Nexttiername; string; The possible tier name to which the member can upgrade, while considering the number of qualifying points that are required to achieve that tier. There is no default value, dependency, or limitation associated with this attribute.
    • Presentqualpoints; number; The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on the point balance of the member. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute.
    • Qualpointstoupgrade; number; The qualifying points required to upgrade to the next tier. For example, if the present qualifying balance for the member is 100 points and the current tier is Silver, then to upgrade to the Gold tier, the member requires another 50 points. In this example, the Qualpointstoupgrade attribute is 50. There is no default value, dependency, or limitation associated with this attribute.
    • ReasonForChange; string; The reason for the change of the member tier. The attribute gets its value when the Oracle Loyally Cloud engine initiates the tier processing. This attribute shows the reason why particular members have their tier changed. There is no default value, dependency, or limitation associated with this attribute.
    • StartDate; string; The date when the member tier starts. For example, if the member's current tier is Silver and previously the tier was Bronze, then the Bronze tier has a start date and an end date which signifies the time period the member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute.
    • TierClassName; string; The tier class name. In member tier records, for each tier to which the member belongs, there is a corresponding tier class name which categorizes the tiers in a loyalty system. There is no default value, dependency, or limitation associated with this attribute.
    • Tierqualpoints; integer; The tier qualifying points threshold, which is the minimum qualifying points required to achieve the current tier for a member. There is no default value, dependency, or limitation associated with this attribute.
    • Tilldate; string; The date until when the qualifying points need to be accrued in order to attain the current tier. There is no default value, dependency, or limitation associated with this attribute.
  • 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
  • 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 : loyaltyMembers-MemberTiers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : loyaltyMembers-MemberTiers-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 1
    The active status of the member tier, which shows the current active tier to which a member belongs. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 64
    The user identifier of the user that made the change to the current member tier represented by this record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tier Name
    Read Only: true
    Maximum Length: 30
    The current tier of the member, which displays the information about which tier the member currently belongs to. Because the member might be promoted from a lower tier, there might be multiple records which show the tiers that are related to the member. For example, a member initially in a silver tier might be promoted to a gold tier. In this case, there are two tier records related to the member, one for gold which is active, and another for silver which is not active. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date when the member tier ends. The member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Read Only: true
    The tier class identifier of a member tier, which is a reference identifier that uniquely identifies a member tier class. It provides information about which tier class the current member tier record belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The tier identifier of the member tier which is the unique identifier to identify a loyalty tier. For example, if a member currently belongs to the Silver tier, then to identify the Silver tier, Oracle Loyalty Cloud uses the LoyTierId attribute as an internal Identifier. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member reference identifier for the current member tier child records, which provides information about the current member tier to which the member belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The member tier identifier. The Internal identifier for the member tier for which the member tier record exists. For example, if the member has a current tier of Silver, then the record in the Member Tier object has an entry for Member Id with MemberTierId as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The identifier of the possible tier to which the member can upgrade, while considering the number of qualifying points that are required to achieve that tier. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 30
    The possible tier name to which the member can upgrade, while considering the number of qualifying points that are required to achieve that tier. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on the point balance of the member. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The qualifying points required to upgrade to the next tier. For example, if the present qualifying balance for the member is 100 points and the current tier is Silver, then to upgrade to the Gold tier, the member requires another 50 points. In this example, the Qualpointstoupgrade attribute is 50. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 250
    The reason for the change of the member tier. The attribute gets its value when the Oracle Loyally Cloud engine initiates the tier processing. This attribute shows the reason why particular members have their tier changed. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date when the member tier starts. For example, if the member's current tier is Silver and previously the tier was Bronze, then the Bronze tier has a start date and an end date which signifies the time period the member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tier Class Name
    Read Only: true
    Maximum Length: 30
    The tier class name. In member tier records, for each tier to which the member belongs, there is a corresponding tier class name which categorizes the tiers in a loyalty system. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The tier qualifying points threshold, which is the minimum qualifying points required to achieve the current tier for a member. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date until when the qualifying points need to be accrued in order to attain the current tier. There is no default value, dependency, or limitation associated with this attribute.
Back to Top

Examples

This example shows how to search for Loyalty member tiers, which are child objects of a member.

Use GET with the following URI syntax to search for Loyalty member tiers that are children of a member:

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

Example of Response Header

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

Example of Response Body

{
    "items": [
        {
            "ReasonForChange": null,
            "EndDate": null,
            "StartDate": "2017-08-03T02:05:26.607-07:00",
            "MemberId": 300100090905742,
            "Active": "Y",
            "ChangedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "MemTierId": 300100090905761,
            "TierClass": "Default Tier Class",
            "LoyTierClsId": 300100090905735,
            "CurrentTier": "Default Tier",
            "LoyTierId": 300100090905736,
            "Tilldate": null,
            "Nexttierid": null,
            "Nexttiername": null,
            "Tierqualpoints": null,
            "Qualpointstoupgrade": null,
            "Presentqualpoints": null,
            "links": [
                {
                    "rel": "self",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberTiers/00030000000EACED00057708000110F07F50C4A10000000EACED00057708000110F07F50C4870000000EACED00057708000110F07F50C488",
                    "name": "MemberTiers",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743/child/MemberTiers/00030000000EACED00057708000110F07F50C4A10000000EACED00057708000110F07F50C4870000000EACED00057708000110F07F50C488",
                    "name": "MemberTiers",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembers/300100090905743",
                    "name": "loyaltyMembers",
                    "kind": "item"
                }
            ]
        }
    ],
    "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/MemberTiers",
            "name": "MemberTiers",
            "kind": "collection"
        }
    ]
}
Back to Top