Jump to

• Request
• Response

Get a tier class

get

/crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses/{TierClassesUniqID}

Request

Path Parameters

• LoyProgramId(required): integer(int64)
  The primary key to identify a program. Oracle Loyalty Cloud generates this attribute value during the creation of a program record. There is no default value, dependency, or limitation associated with this attribute.
• TierClassesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Tier Classes resource and used to uniquely identify an instance of Tier Classes. The client should not generate the hash key value. Instead, the client should query on the Tier Classes collection resource in order to navigate to a specific instance of Tier Classes to get the hash key.

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 : loyPrograms-TierClasses-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  The boolean attribute that identifies whether the tier class is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
• ApplyFlag: boolean
  Title: Tier Class Applied

  Maximum Length: 1

  Default Value: false

  The boolean attribute that specifies whether the tier class is applied to existing members. The default value is N. There is no dependency or limitation associated with this attribute.
• ApproverId: integer (int64)
  Title: Approver ID

  The user that approves tier downgrades. There is no dependency or limitation associated with this attribute.
• AssessDateCode: string
  Title: Assessment Day

  Maximum Length: 30

  Default Value: 1

  The tier assess date code specifies the day to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.
• AssessMonth: string
  Title: Assessment Month

  Maximum Length: 30

  Default Value: 1

  The tier assess month identifier specifies the month to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.
• AssessRecur: string
  Title: Recurring Period Meaning

  Read Only: true

  Maximum Length: 80

  The tier assess recurring attribute specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.
• AssessRecurCode: string
  Title: Recurring Period

  Maximum Length: 30

  Default Value: ORA_TR_LEN_UOM_YEAR

  The tier assess recurring code specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.
• CardType: string
  Title: Card Type Meaning

  Read Only: true

  Maximum Length: 80

  The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.
• CardTypeCode: string
  Title: Card Type Code

  Read Only: true

  Maximum Length: 30

  The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that created the tier class. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the tier class is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
• EndTierlenUOMCode: string
  Title: End Tier Length Unit of Measure

  Maximum Length: 30

  The tier end date is calculated using the value of the Minimum Tier Length and Minimum Tier Length Period parameters. The minimum period specifies the time that a member is guaranteed membership in any tier within the tier class. For example, if the minimum period is six months, then length is 6, and Period UOM is Month. There is no default value or limitation associated with this attribute.
• EndTierMthDyCode: string
  Title: End Tier Period Month

  Maximum Length: 30

  The end tier month day code attribute specifies the day of the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.
• EndTierPdDayCode: string
  Title: End Tier Period Day

  Maximum Length: 30

  The end tier period day code attribute specifies the day when the tier period ends. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the tier class record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. 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)
  Title: Loyalty Tier Class ID

  The primary key of the loyalty tier class. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MinimumTierLength: integer (int32)
  Title: Minimum Tier Length in Months

  The minimum period of time that a member is guaranteed membership in any tier within this tier class. For example, if the minimum period is six months, then length is 6 and Period is Month. There is no default value, dependency, or limitation associated with this attribute.
• PrimaryTierName: string
  Title: Primary Tier

  Maximum Length: 30

  The attribute indicates the name of primary tier of a tier class. A tier class can have only one primary tier class. There is no default value, dependency, nor limitation associated with this attribute.
• PrTierId: integer (int64)
  Title: Primary Tier ID

  The primary tier identifier is the lowest tier of the tier class and is the tier where members are first enrolled. This value can only be specified after the tiers have been created for this class, and it must be specified before activating the tier class. There is no default value, dependency, or limitation associated with this attribute.
• QualifyingPoints: integer (int64)
  Title: Qualifying Points

  Read Only: true

  The attribute indicates the minimum number of points required to qualify a tier. There is no dependency or limitation associated with this attribute.
• QualPeriodLength: integer (int32)
  Title: Qualifying Period Length in Months

  The qualifying period length specifies the length for the initial qualifying period for the tier. For example, if the qualifying period is one year, the period length is 1. It is recommended that the Quality Period Length be defined at the Tier Class level. However, if the Quality Period Length is defined at Tier level, then the tier level definition takes precedence. There is no default value, dependency, or limitation associated with this attribute.
• QualPeriodUOMCode: string
  Title: Qualifying Period Unit of Measure

  Maximum Length: 30

  The qualifying period unit of measure (UOM) code specifies the UOM for the initial qualifying period for the tier. For example, if the qualifying period is one year, then UOM is Year. There is no default value, dependency, or limitation associated with this attribute.
• QualPointTypeId: integer (int64)
  Title: Qualifying Point Type

  The unique identifier of the qualifying point type of a tier class. There is no dependency or limitation associated with this attribute.
• RequalPdUOMCode: string
  Title: Requalifying Period Unit of Measure

  Maximum Length: 30

  The requalifying period unit of measure (UOM) code specifies the UOM for the qualifying period for existing members to remain in this tier. Usually, this period is the same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.
• RequalPeriodLength: number
  Title: Requalifying Period Length

  The requalifying period length identifier specifies the length for the qualifying period for existing members to remain in the same tier. Usually, the period is same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.
• RestartQualPeriodCode: string
  Title: Restart Qualifying Period

  Maximum Length: 30

  The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.
• SequenceNumber: number
  Title: Sequence Number

  Read Only: true

  The unique sequence number of the corresponding tier of a tier class. There is no dependency or limitation associated with this attribute.
• Snapto: string
  Title: Tier End Date Snapped to Meaning

  Read Only: true

  Maximum Length: 80

  The attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year, or a calculated date.
• SnaptoCode: string
  Title: Tier End Date Snapped To

  Maximum Length: 30

  Default Value: ORA_EXP_ADJ_CALC_DATE

  This attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year or calculated date.
• StartQualPeriod: string
  Title: Tier Assessment Model Meaning

  Read Only: true

  Maximum Length: 80

  The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.
• StartQualPeriodCode: string
  Title: Tier Assessment Model

  Maximum Length: 30

  Default Value: ORA_TR_MODEL_NONE

  The start qualifying period code specifies when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STQualPeriodDay: integer (int32)
  Title: Start Qualifying Period Day

  This attribute indicates tier qualifying period start day. There is no dependency or limitation associated with this attribute.
• STQualPeriodDayCode: string
  Title: Start Qualifying Period Day

  Maximum Length: 30

  The start qualifying period day code specifies the day from when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STQualPeriodMonthCode: string
  Title: Start Qualifying Period Month

  Maximum Length: 30

  The start qualifying period month code specifies the month from when the qualifying period starts. The option determines the tier assessment model. The possible options are: Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, Rolling. There is no default value, dependency, or limitation associated with this attribute.
• STTierPeriodDay: integer (int32)
  Title: Start Tier Period Day

  This attribute indicates tier period start day. There is no dependency or limitation associated with this attribute.
• STTierPeriodDayCode: string
  Title: Start Tier Period Day

  Maximum Length: 30

  The start tier period day specifies the day from when the tier period starts. The possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.
• STTierPeriodMonthCode: string
  Title: Start Tier Period Month

  Maximum Length: 30

  The start tier period month specifies the month from when the tier period month starts. Possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.
• TierClassName: string
  Title: Tier Class Name

  Maximum Length: 30

  The attribute is a unique identifier that indicates the name of the tier class. There is no default value, dependency, or limitation associated with this attribute.
• TierId: integer (int64)
  Title: Loyalty Tier ID

  Read Only: true

  The primary key of loyalty tiers corresponding to a tier class. There is no dependency or limitation associated with this attribute.
• TierName: string
  Title: Tier Name

  Read Only: true

  Maximum Length: 30

  The name of tier defined under the tier class. There is no default value, dependency, or limitation associated with this attribute.
• TierPeriodLength: integer (int32)
  Title: Tier Period Length in Months

  This attribute indicates tier period length. There is no dependency or limitation associated with this attribute.
• TypeCode: string
  Title: Type Code

  Maximum Length: 30

  The type code attribute previously specified the tier class type in a multiple tier class scenario. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the tier class is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "STQualPeriodDay":{
            "title":"Start Qualifying Period Day",
            "type":"integer",
            "description":"This attribute indicates tier qualifying period start day. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "AssessDateCode":{
            "title":"Assessment Day",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess date code specifies the day to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SnaptoCode":{
            "title":"Tier End Date Snapped To",
            "maxLength":30,
            "type":"string",
            "description":"This attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year or calculated date.",
            "nullable":true,
            "default":"ORA_EXP_ADJ_CALC_DATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssessRecur":{
            "title":"Recurring Period Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The tier assess recurring attribute specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "AssessRecurCode":{
            "title":"Recurring Period",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess recurring code specifies how frequently the tier assessment schedule is repeated. Assessment recurrence period options are Monthly and Yearly. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_TR_LEN_UOM_YEAR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequalPeriodLength":{
            "title":"Requalifying Period Length",
            "type":"number",
            "description":"The requalifying period length identifier specifies the length for the qualifying period for existing members to remain in the same tier. Usually, the period is same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RestartQualPeriodCode":{
            "title":"Restart Qualifying Period",
            "maxLength":30,
            "type":"string",
            "description":"The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EndTierPdDayCode":{
            "title":"End Tier Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The end tier period day code attribute specifies the day when the tier period ends. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CardTypeCode":{
            "title":"Card Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryTierName":{
            "title":"Primary Tier",
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates the name of primary tier of a tier class. A tier class can have only one primary tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartQualPeriod":{
            "title":"Tier Assessment Model Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The restart qualifying period specifies the length of time for the new qualifying period that starts after a tier status change. Possible options are Qualifying Period Expiration (the length of time after the new qualifying period starts at the expiration of the current qualifying period) or Tier Status Change (the length of time for the new qualifying period to start, immediately when the tier changes). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "QualPeriodLength":{
            "title":"Qualifying Period Length in Months",
            "type":"integer",
            "description":"The qualifying period length specifies the length for the initial qualifying period for the tier. For example, if the qualifying period is one year, the period length is 1. It is recommended that the Quality Period Length be defined at the Tier Class level. However, if the Quality Period Length is defined at Tier level, then the tier level definition takes precedence. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "STTierPeriodMonthCode":{
            "title":"Start Tier Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The start tier period month specifies the month from when the tier period month starts. Possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "STTierPeriodDay":{
            "title":"Start Tier Period Day",
            "type":"integer",
            "description":"This attribute indicates tier period start day. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "TierPeriodLength":{
            "title":"Tier Period Length in Months",
            "type":"integer",
            "description":"This attribute indicates tier period length. There is no dependency or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CardType":{
            "title":"Card Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the member card type associated with a tier under a tier class. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"The unique sequence number of the corresponding tier of a tier class. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproverId":{
            "title":"Approver ID",
            "type":"integer",
            "description":"The user that approves tier downgrades. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":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"
            }
        },
        "EndTierMthDyCode":{
            "title":"End Tier Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The end tier month day code attribute specifies the day of the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "STQualPeriodMonthCode":{
            "title":"Start Qualifying Period Month",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period month code specifies the month from when the qualifying period starts. The option determines the tier assessment model. The possible options are: Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "STTierPeriodDayCode":{
            "title":"Start Tier Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The start tier period day specifies the day from when the tier period starts. The possible options of Start Tier Period are Enrollment/Anniversary Date or Fixed date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyTierClsId":{
            "title":"Loyalty Tier Class ID",
            "type":"integer",
            "description":"The primary key of the loyalty tier class. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssessMonth":{
            "title":"Assessment Month",
            "maxLength":30,
            "type":"string",
            "description":"The tier assess month identifier specifies the month to schedule a tier assessment for a tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequalPdUOMCode":{
            "title":"Requalifying Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The requalifying period unit of measure (UOM) code specifies the UOM for the qualifying period for existing members to remain in this tier. Usually, this period is the same as the initial qualifying period. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user that created the tier class. Oracle Loyalty Cloud generates this attribute value during the creation of a new tier class. 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 attribute is a unique identifier that indicates the name of the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type code attribute previously specified the tier class type in a multiple tier class scenario. Oracle Loyalty Cloud does not currently use this attribute. There is no default value, dependency, nor limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyFlag":{
            "title":"Tier Class Applied",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that specifies whether the tier class is applied to existing members. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "STQualPeriodDayCode":{
            "title":"Start Qualifying Period Day",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period day code specifies the day from when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QualPeriodUOMCode":{
            "title":"Qualifying Period Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The qualifying period unit of measure (UOM) code specifies the UOM for the initial qualifying period for the tier. For example, if the qualifying period is one year, then UOM is Year. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"The boolean attribute that identifies whether the tier class is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PrTierId":{
            "title":"Primary Tier ID",
            "type":"integer",
            "description":"The primary tier identifier is the lowest tier of the tier class and is the tier where members are first enrolled. This value can only be specified after the tiers have been created for this class, and it must be specified before activating the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualifyingPoints":{
            "title":"Qualifying Points",
            "type":"integer",
            "description":"The attribute indicates the minimum number of points required to qualify a tier. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "TierId":{
            "title":"Loyalty Tier ID",
            "type":"integer",
            "description":"The primary key of loyalty tiers corresponding to a tier class. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MinimumTierLength":{
            "title":"Minimum Tier Length in Months",
            "type":"integer",
            "description":"The minimum period of time that a member is guaranteed membership in any tier within this tier class. For example, if the minimum period is six months, then length is 6 and Period is Month. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Tier Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of tier defined under the tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Snapto":{
            "title":"Tier End Date Snapped to Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The attribute indicates the date of the tier end that should map with for the member's tier record. Possible values in this are 1st day of Month, 1st day of Quarter, 1st day of year, or a calculated date.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "StartQualPeriodCode":{
            "title":"Tier Assessment Model",
            "maxLength":30,
            "type":"string",
            "description":"The start qualifying period code specifies when the qualifying period starts. The option determines the tier assessment model. The possible options are Enrollment Date/Anniversary Date, First Day of Month, Fixed Date, and Rolling. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "default":"ORA_TR_MODEL_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "QualPointTypeId":{
            "title":"Qualifying Point Type",
            "type":"integer",
            "description":"The unique identifier of the qualifying point type of a tier class. There is no dependency or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the tier class record is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user that last updated the tier class. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes to the tier class occur. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTierlenUOMCode":{
            "title":"End Tier Length Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The tier end date is calculated using the value of the Minimum Tier Length and Minimum Tier Length Period parameters. The minimum period specifies the time that a member is guaranteed membership in any tier within the tier class. For example, if the minimum period is six months, then length is 6, and Period UOM is Month. There is no default value 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."
        }
    }
}

Links

CardTypeLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CARD_TYPE

The lookups resource is used to view standard lookup codes.

RecurringPeriodPVO2

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TIER_LEN_UOM

The lookups resource is used to view standard lookup codes.

TierAssessModelPVO1

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_TIER_ASSESS_MODEL

The lookups resource is used to view standard lookup codes.

TierEndDateSnappedToPVO1

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_EXP_ADJ

The lookups resource is used to view standard lookup codes.

Back to Top