REST API for Oracle Loyalty Cloud

Get a tier (Deprecated)

get

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

Request

Path Parameters

MemberNumber(required): string

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.
MemberTiersUniqID(required): string

This is the hash key of the attributes which make up the composite key--- MemTierId, LoyTierClsId and LoyTierId ---for the (Deprecated) Member Tiers resource and used to uniquely identify an instance of (Deprecated) Member Tiers. The client should not generate the hash key value. Instead, the client should query on the (Deprecated) Member Tiers collection resource with a filter on the primary key values in order to navigate to a specific instance of (Deprecated) Member Tiers.

For example: MemberTiers?q=MemTierId=<value1>;LoyTierClsId=<value2>;LoyTierId=<value3>

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.

Response

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 : loyaltyMembers-MemberTiers-item-response

Type: object

Show Source

Active: string

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.
ChangedBy: string

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.
CurrentTier: string

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.
EndDate: string (date-time)

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: array Links

Title: Links

The link relations associated with the resource instance.
LoyTierClsId: integer (int64)

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.
LoyTierId: integer (int64)

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.
MemberId: integer (int64)

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.
MemTierId: integer (int64)

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.
Nexttierid: integer (int64)

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.
Nexttiername: string

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.
Presentqualpoints: number

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.
Qualpointstoupgrade: number

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.
ReasonForChange: string

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.
StartDate: string (date-time)

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.
TierClassName: string

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.
Tierqualpoints: integer (int64)

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.
Tilldate: string (date)

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.

{
    "type":"object",
    "properties":{
        "LoyTierClsId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyTierId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangedBy":{
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassName":{
            "title":"Tier Class Name",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentTier":{
            "title":"Tier Name",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Active":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemTierId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Nexttiername":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Tierqualpoints":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "Presentqualpoints":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Nexttierid":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReasonForChange":{
            "maxLength":250,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Qualpointstoupgrade":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Tilldate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}