Jump to

• Request
• Response

Get all tier classes (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/TierClasses

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.

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the tier class with the specified tier class identifier.
    Finder Variables:
    • LoyTierClsId; integer; The tier class identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveFlg; string; 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.
  • ApplyFlg; string; 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; The user that approves tier downgrades. The default value is N. There is no dependency or limitation associated with this attribute.
  • AssessDateCode; string; 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; 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.
  • AssessRecurCode; string; 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.
  • ConflictId; integer; The tier class conflict identifier that Oracle Loyalty Cloud generates during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
  • CreatedBy; string; The loyalty 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; 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.
  • EndTierMthDyCode; string; The end tier month day code attribute specifies the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.
  • EndTierPdDayCode; string; 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.
  • EndTierlenUOMCode; string; 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.
  • LastUpdateDate; string; 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.
  • LastUpdateLogin; string; 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.
  • LastUpdatedBy; string; 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.
  • LoyTierClsId; integer; 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.
  • LoyTierId; integer; The primary key of loyalty tiers. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • MinimumTierLen; integer; 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.
  • ObjectVersionNumber; integer; The tier class object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • PrTierId; integer; 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.
  • QualPdUOMCode; string; 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.
  • QualPeriodLen; integer; 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.
  • RequalPdUOMCode; string; 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.
  • RequalPeriodLen; integer; 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.
  • RestartQualPdCode; string; 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.
  • STQualPdDayCode; string; 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.
  • STQualPdMthCode; string; 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.
  • STTierPdDayCode; string; 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.
  • STTierPdMthCode; string; 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.
  • SequenceNo; integer; The sequence number indicates how high the status of this tier class is, compared with other tier classes. For example, a frequent flyer program might include a standard class set to 1, a business class set to 2, and first class set to 3. There is no default value, dependency, or limitation associated with this attribute.
  • StartQualPdCode; string; 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.
  • TierClassName; string; 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.
  • TierName; string; The unique identifier that indicates name of the tier. There is no default value, dependency, or limitation associated with this attribute.
  • TypeCode; string; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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:
  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.

Body ()

Root Schema : loyaltyPrograms-TierClasses

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/loyaltyPrograms-TierClasses-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object loyaltyPrograms-TierClasses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/loyaltyPrograms-TierClasses-item-response"
    }
}

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

Type: object

Show Source

• ActiveFlg: string
  Maximum Length: 1

  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.
• ApplyFlg: string
  Maximum Length: 1

  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)
  The user that approves tier downgrades. The default value is N. There is no dependency or limitation associated with this attribute.
• AssessDateCode: string
  Maximum Length: 30

  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
  Maximum Length: 30

  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.
• AssessRecurCode: string
  Maximum Length: 30

  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.
• ConflictId: integer (int64)
  The tier class conflict identifier that Oracle Loyalty Cloud generates during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Maximum Length: 64

  The loyalty 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)
  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
  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
  Maximum Length: 30

  The end tier month day code attribute specifies the month when the tier period month ends. There is no default value, dependency, or limitation associated with this attribute.
• EndTierPdDayCode: string
  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)
  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
  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
  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)
  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.
• LoyTierId: integer (int64)
  Read Only: true

  The primary key of loyalty tiers. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
• MinimumTierLen: integer (int32)
  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.
• ObjectVersionNumber: integer (int32)
  The tier class object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• PrTierId: integer (int64)
  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.
• QualPdUOMCode: string
  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.
• QualPeriodLen: integer (int32)
  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.
• RequalPdUOMCode: string
  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.
• RequalPeriodLen: integer (int32)
  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.
• RestartQualPdCode: string
  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.
• SequenceNo: integer (int32)
  The sequence number indicates how high the status of this tier class is, compared with other tier classes. For example, a frequent flyer program might include a standard class set to 1, a business class set to 2, and first class set to 3. There is no default value, dependency, or limitation associated with this attribute.
• StartQualPdCode: string
  Maximum Length: 30

  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.
• STQualPdDayCode: string
  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.
• STQualPdMthCode: string
  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.
• STTierPdDayCode: string
  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.
• STTierPdMthCode: string
  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.
• TierName: string
  Title: Tier Name

  Read Only: true

  Maximum Length: 30

  The unique identifier that indicates name of the tier. There is no default value, dependency, or limitation associated with this attribute.
• TypeCode: string
  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":{
        "SequenceNo":{
            "type":"integer",
            "description":"The sequence number indicates how high the status of this tier class is, compared with other tier classes. For example, a frequent flyer program might include a standard class set to 1, a business class set to 2, and first class set to 3. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "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,
            "x-queryable":true
        },
        "AssessDateCode":{
            "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,
            "x-queryable":true
        },
        "AssessRecurCode":{
            "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,
            "x-queryable":true
        },
        "EndTierPdDayCode":{
            "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
        },
        "ConflictId":{
            "type":"integer",
            "description":"The tier class conflict identifier that Oracle Loyalty Cloud generates during the creation of a new tier class. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The tier class object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ApproverId":{
            "type":"integer",
            "description":"The user that approves tier downgrades. The default value is N. 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":{
            "maxLength":"30",
            "type":"string",
            "description":"The end tier month day code attribute specifies 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
        },
        "ApplyFlg":{
            "maxLength":"1",
            "type":"string",
            "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,
            "x-queryable":true
        },
        "LoyTierId":{
            "type":"integer",
            "description":"The primary key of loyalty tiers. Oracle Loyalty Cloud generates this attribute value. 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
        },
        "LoyTierClsId":{
            "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"
            },
            "x-queryable":true
        },
        "STTierPdMthCode":{
            "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-queryable":true
        },
        "LastUpdatedBy":{
            "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,
            "x-queryable":true
        },
        "QualPdUOMCode":{
            "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
        },
        "RequalPdUOMCode":{
            "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
        },
        "AssessMonth":{
            "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,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The loyalty 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,
            "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":false,
            "x-queryable":true
        },
        "STQualPdDayCode":{
            "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
        },
        "QualPeriodLen":{
            "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
        },
        "TypeCode":{
            "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
        },
        "PrTierId":{
            "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
        },
        "STTierPdDayCode":{
            "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
        },
        "StartQualPdCode":{
            "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,
            "x-queryable":true
        },
        "TierName":{
            "title":"Tier Name",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier that indicates name of the tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlg":{
            "maxLength":"1",
            "type":"string",
            "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,
            "x-queryable":true
        },
        "MinimumTierLen":{
            "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
        },
        "RequalPeriodLen":{
            "type":"integer",
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RestartQualPdCode":{
            "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
        },
        "STQualPdMthCode":{
            "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-queryable":true
        },
        "EndTierlenUOMCode":{
            "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
        },
        "LastUpdateLogin":{
            "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,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "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,
            "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