Jump to

• Request
• Response

Get a tier detail for a given loyalty member

get

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTier/{MemTierId}

Request

Path Parameters

• MemTierId(required): integer(int64)
  The member tier identifier, which is an 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 MemberId with MemberTierid as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber(required): string
  The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.

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.

Back to Top

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.

Body ()

Root Schema : loyMembers-MemberTier-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  The Active flag represents whether the tier which is active among all the member tier records. For example a member might be promoted from a silver to gold tier. There will be two records, one for silver and another for gold but the record with gold tier is marked as active which means the member currently belongs to the gold tier. The default value is N, but there is no dependency, or limitation associated with this attribute.
• Comments: string
  Title: Reason for Change

  Maximum Length: 250

  The comments provided by the Loyalty Engine while changing the member tier. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Changed By

  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.
• EndDt: string (date-time)
  Title: End Date

  The date when the member tier ends. The loyalty member is active in a particular member tier until this date. There is no default value, dependency, or limitation associated with this attribute.
• FromTierName: string
  Title: Tier Name

  Read Only: true

  Maximum Length: 30

  The previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute.
• FromTierStartDate: string (date)
  Title: From Tier Start Date

  The tier start date of the current tier. There is no default value, dependency, or limitation associated with this attribute.
• FutrTierName: string
  Title: Tier Name

  Read Only: true

  Maximum Length: 30

  The next immediate tier name for the member to upgrade. There is no default value, dependency, or limitation associated with this attribute.
• FutrTierStampDt: string (date)
  Title: Future Tier Date

  The Stamp Future Tier attribute flags the future tier assessment date details if it is likely that a member will be downgraded or requalified based on the Tier Effective Period End Date. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Change Date

  Read Only: true

  The member tier record last update date. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the member tier in the UI. 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.
• LookupCode: string
  Title: Lookup Code

  Read Only: true

  Maximum Length: 30

  The Lookup Code attribute shows additional information for the reason for the change to the member tier. The corresponding lookupType is ORA_LOY_TIER_CHANGE_REASON. This attribute is dependent on LookupType. This attribute does not have a default value.
• LookupType: string
  Title: Lookup Type

  Read Only: true

  Maximum Length: 30

  The lookup type corresponding to the Reason for Change value of the member tier change. The lookup type value is ORA_LOY_TIER_CHANGE_REASON. There is no default value, dependency, or limitation associated with this attribute.
• LoyTierClsId: integer (int64)
  Title: Loyalty Tier Class ID

  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)
  Title: Loyalty Tier ID

  Read Only: true

  The tier identifier of the member tier which uniquely identifies 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)
  Title: Member ID

  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)
  Title: Member Tier ID

  The member tier identifier, which is an 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 MemberId with MemberTierid as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.
• MemTierNum: string
  Title: Member Tier Number

  Maximum Length: 30

  The unique identifier which shows the number of the tier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute.
• NextAssessDt: string (date)
  Title: Next Tier Assessment Date

  The date on which the next tier assessment occurs for the member. There is no default value, dependency, or limitation associated with this attribute.
• NextTierName: string
  Read Only: true

  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.
• OrigEndDt: string (date-time)
  Title: Original Tier End Date

  The system-generated tier end date for the tier record. There is no default value, dependency, or limitation associated with this attribute.
• OverrideDt: string (date)
  Title: Override Date

  The date on which a tier change occurs and overrides the tier end date. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeAVal: number
  Title: Point Type A Value

  The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeBVal: number
  Title: Point Type B Value

  The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeCVal: number
  Title: Point Type C Value

  The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeDVal: number
  Title: Point Type D Value

  The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeEVal: number
  Title: Point Type E Value

  The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeFVal: number
  Title: Point Type F Value

  The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeGVal: number
  Title: Point Type G Value

  The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.
• PointTypeHVal: number
  Title: Point Type H Value

  The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. 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 a loyalty member's point balance. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute.
• ProcessedDt: string (date)
  Title: Processed Date

  The date when the member tier is processed. When the Oracle Loyalty Cloud engine initiates tier processing, it sets the date when it updates the tier. There is no default value, dependency, or limitation associated with this attribute.
• ProcessingComment: string
  Title: Processing Comment

  Maximum Length: 1000

  The tier processing comment that provides the details of an error, if any occurred, during tier processing. There is no default value, dependency, or limitation associated with this attribute.
• ProcessingLog: string
  Title: Processing Log

  Maximum Length: 1000

  The tier processing log that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute.
• ProcessingStatCode: string
  Title: Processing Status

  Maximum Length: 30

  The tier processing status code that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The name of the loyalty program in which the current loyalty member is enrolled. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of the promotion that has been applied and for which the tier is created. There is no default value, dependency, or limitation associated with this attribute.
• QualEndDate: string (date-time)
  Title: Qualifying End Date

  The qualifying end date of the member tier. There is no default value, dependency, or limitation associated with this attribute.
• QualFlag: boolean
  Title: Qualifying

  Maximum Length: 1

  The flag that indicates the points are of type qualifying points. 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, consider that the present qualifying balance for the loyalty member is 100 points and the current tier is Silver, and 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.
• QualStartDate: string (date-time)
  Title: Qualifying Start Date

  The qualifying start date of the member tier. There is no default value, dependency, or limitation associated with this attribute.
• ReasonValue: string
  Title: Reason for Change Meaning

  Maximum Length: 80

  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 loyalty members get their tiers changed. There is no default value, dependency, or limitation associated with this attribute.
• StartDt: string (date-time)
  Title: Start Date

  The date when the member tier starts. For example, if the loyalty 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 that the loyalty member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute.
• StartQualPd: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The LOV Meaning of the LOV Code 'StaryQualPdCode'. The lookup code value of the loyalty tier assessment model that is used to change this tier. There is no dependency or limitation associated with this attribute.
• StartQualPdCode: string
  Title: Start Qualifying Period

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_TR_MODEL_NONE

  The lookup code value of loyalty tier assessment model used to change this tier. The default value is ORA_TR_MODEL_NONE. There is no dependency or limitation associated with this attribute.
• TierClassId: integer (int64)
  Title: Tier Class ID

  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.
• TierClassName: string
  Title: Tier Class

  Read Only: true

  Maximum Length: 30

  The tier class name. For each tier to which the member belongs in the Loyalty Member tier records, 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.
• TierId: integer (int64)
  Title: Tier ID

  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.
• TierName: string
  Title: Tier

  Maximum Length: 30

  The tier name to which the member currently belongs. There is no default value, dependency, or limitation associated with this attribute.
• TierQualPoints: number
  Read Only: true

  The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on a loyalty member's point balance. This attribute provides information about the current balance. There is no default value, dependency, or limitation associated with this attribute.
• TillDate: string (date)
  Read Only: true

  The date to 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":{
        "ProcessingComment":{
            "title":"Processing Comment",
            "maxLength":1000,
            "type":"string",
            "description":"The tier processing comment that provides the details of an error, if any occurred, during tier processing. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualEndDate":{
            "title":"Qualifying End Date",
            "type":"string",
            "description":"The qualifying end date of the member tier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FromTierStartDate":{
            "title":"From Tier Start Date",
            "type":"string",
            "description":"The tier start date of the current tier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FromTierName":{
            "title":"Tier Name",
            "maxLength":30,
            "type":"string",
            "description":"The previous tier name from which the loyalty member is promoted to the current tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TillDate":{
            "type":"string",
            "description":"The date to 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
        },
        "TierQualPoints":{
            "type":"number",
            "description":"The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on a loyalty member's point balance. 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
        },
        "OverrideDt":{
            "title":"Override Date",
            "type":"string",
            "description":"The date on which a tier change occurs and overrides the tier end date. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingLog":{
            "title":"Processing Log",
            "maxLength":1000,
            "type":"string",
            "description":"The tier processing log that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PointTypeBVal":{
            "title":"Point Type B Value",
            "type":"number",
            "description":"The points for the member from Point Type B as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the promotion that has been applied and for which the tier is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PointTypeFVal":{
            "title":"Point Type F Value",
            "type":"number",
            "description":"The points for the member from Point Type F as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyTierClsId":{
            "title":"Loyalty Tier Class ID",
            "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
        },
        "NextTierName":{
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PresentQualPoints":{
            "type":"number",
            "description":"The present qualifying point balance for the member. Oracle Loyalty Cloud calculates this attribute value based on a loyalty member's point balance. 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
        },
        "NextAssessDt":{
            "title":"Next Tier Assessment Date",
            "type":"string",
            "description":"The date on which the next tier assessment occurs for the member. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Changed By",
            "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
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The lookup type corresponding to the Reason for Change value of the member tier change. The lookup type value is ORA_LOY_TIER_CHANGE_REASON. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The name of the loyalty program in which the current loyalty member is enrolled. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The Active flag represents whether the tier which is active among all the member tier records. For example a member might be promoted from a silver to gold tier. There will be two records, one for silver and another for gold but the record with gold tier is marked as active which means the member currently belongs to the gold tier. The default value is N, but there is no dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonValue":{
            "title":"Reason for Change Meaning",
            "maxLength":80,
            "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 loyalty members get their tiers changed. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartQualPdCode":{
            "title":"Start Qualifying Period",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code value of loyalty tier assessment model used to change this tier. The default value is ORA_TR_MODEL_NONE. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_TR_MODEL_NONE",
            "x-queryable":true
        },
        "PointTypeAVal":{
            "title":"Point Type A Value",
            "type":"number",
            "description":"The points for the member from Point Type A as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "FutrTierName":{
            "title":"Tier Name",
            "maxLength":30,
            "type":"string",
            "description":"The next immediate tier name for the member to upgrade.  There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierName":{
            "title":"Tier",
            "maxLength":30,
            "type":"string",
            "description":"The tier name to which the member currently belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MemTierNum":{
            "title":"Member Tier Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier which shows the number of the tier to which the loyalty member belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PointTypeEVal":{
            "title":"Point Type E Value",
            "type":"number",
            "description":"The points for the member from Point Type E as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualStartDate":{
            "title":"Qualifying Start Date",
            "type":"string",
            "description":"The qualifying start date of the member tier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartQualPd":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The LOV Meaning of the LOV Code 'StaryQualPdCode'. The lookup code value of the loyalty tier assessment model that is used to change this tier. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the member tier starts. For example, if the loyalty 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 that the loyalty member belonged to that particular tier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EndDt":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the member tier ends. The loyalty 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,
            "x-queryable":true
        },
        "TierClassId":{
            "title":"Tier Class ID",
            "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":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PointTypeHVal":{
            "title":"Point Type H Value",
            "type":"number",
            "description":"The points for the member from Point Type H as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessedDt":{
            "title":"Processed Date",
            "type":"string",
            "description":"The date when the member tier is processed. When the Oracle Loyalty Cloud engine initiates tier processing, it sets the date when it updates the tier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PointTypeDVal":{
            "title":"Point Type D Value",
            "type":"number",
            "description":"The points for the member from Point Type D as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LoyTierId":{
            "title":"Loyalty Tier ID",
            "type":"integer",
            "description":"The tier identifier of the member tier which uniquely identifies 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
        },
        "TierClassName":{
            "title":"Tier Class",
            "maxLength":30,
            "type":"string",
            "description":"The tier class name. For each tier to which the member belongs in the Loyalty Member tier records, 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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Reason for Change",
            "maxLength":250,
            "type":"string",
            "description":"The comments provided by the Loyalty Engine while changing the member tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QualFlag":{
            "title":"Qualifying",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag that indicates the points are of type qualifying points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "FutrTierStampDt":{
            "title":"Future Tier Date",
            "type":"string",
            "description":"The Stamp Future Tier attribute flags the future tier assessment date details if it is likely that a member will be downgraded or requalified based on the Tier Effective Period End Date. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The Lookup Code attribute shows additional information for the reason for the change to the member tier. The corresponding lookupType is ORA_LOY_TIER_CHANGE_REASON. This attribute is dependent on LookupType. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PointTypeCVal":{
            "title":"Point Type C Value",
            "type":"number",
            "description":"The points for the member from Point Type C as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TierId":{
            "title":"Tier ID",
            "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":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemTierId":{
            "title":"Member Tier ID",
            "type":"integer",
            "description":"The member tier identifier, which is an 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 MemberId with MemberTierid as the unique identifier. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessingStatCode":{
            "title":"Processing Status",
            "maxLength":30,
            "type":"string",
            "description":"The tier processing status code that provides the details of all the promotions that are applied. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPointsToUpgrade":{
            "type":"number",
            "description":"The qualifying points required to upgrade to the next tier. For example, consider that the present qualifying balance for the loyalty member is 100 points and the current tier is Silver, and 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
        },
        "LastUpdateDate":{
            "title":"Change Date",
            "type":"string",
            "description":"The member tier record last update date. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the member tier in the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrigEndDt":{
            "title":"Original Tier End Date",
            "type":"string",
            "description":"The system-generated tier end date for the tier record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PointTypeGVal":{
            "title":"Point Type G Value",
            "type":"number",
            "description":"The points for the member from Point Type G as defined in the loyalty program. Oracle Loyalty Cloud refers internally to the point types alphabetically, from A to H. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":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."
        }
    }
}

Back to Top