Jump to

• Request
• Response

Get an enrolled promotion

get

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}

Request

Path Parameters

• LoyPromomemId(required): integer(int64)
  The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber(required): string
  The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : loyMembers-promotions-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The details of who updated the member enrollment into an enrollable promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Created Date

  Read Only: true

  The date when the member enrollment into an enrollable promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.
• EligFlg: string
  Title: Eligibility

  Maximum Length: 1

  Default Value: N

  Indicates if member is eligible or enrolled.
• EnrollmentEnd: string (date-time)
  Title: Enrollment End Date

  The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute.
• EnrollmentStart: string (date-time)
  Title: Enrollment Start Date

  The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.
• IncentiveChoice: string
  Title: Incentive Choice

  The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Changed By

  Read Only: true

  Maximum Length: 64

  The user that updates the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable Promotion in the Oracle Loyalty Cloud UI. 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 who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment into an enrollable promotion take place. 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.
• LoyPromomemId: integer (int64)
  Title: Loyalty Promotion Member ID

  The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute.
• MemberNumber: string
  Title: Member Number

  Maximum Length: 30

  The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute.
• OfferNum: string
  Title: Offer Number

  Maximum Length: 30

  .
• PromoMemNumber: string
  Title: Promotion Member Number

  The public unique identifier of a member promotion enrolled object which is unique to a given enrollment for a given time period. There is no default value or limitation associated with this attribute.
• PromotionName: string
  Title: Promotion Name

  The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute.
• PromotionNumber: string
  Title: Promotion Number

  Read Only: true

  Maximum Length: 30

  The promotion number that has been applied to the member during the transaction processing. There is no default value, dependency, or limitation associated with this attribute.
• SubTypeCode: string
  Title: Promotion Sub Type

  Read Only: true

  Maximum Length: 30

  The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.
• SubTypeCodeMeaning: string
  Title: Promotion Sub Type Meaning

  Read Only: true

  Maximum Length: 80

  The sub type meaning of the promotion. This is dependent on the promotion type. There is no default value or limitation associated with this attribute.
• TypeCode: string
  Title: Promotion Type

  Read Only: true

  Maximum Length: 30

  The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.
• TypeCodeMeaning: string
  Title: Promotion Type Meaning

  Read Only: true

  Maximum Length: 80

  The type meaning of the promotion which is based on the promotion type code. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Changed By",
            "maxLength":64,
            "type":"string",
            "description":"The user that updates the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable Promotion in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnrollmentEnd":{
            "title":"Enrollment End Date",
            "type":"string",
            "description":"The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"The date when the member enrollment into an enrollable promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferNum":{
            "title":"Offer Number",
            "maxLength":30,
            "type":"string",
            "description":".",
            "nullable":true,
            "x-queryable":true
        },
        "LoyPromomemId":{
            "title":"Loyalty Promotion Member ID",
            "type":"integer",
            "description":"The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The details of who updated the member enrollment into an enrollable promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Promotion Type",
            "maxLength":30,
            "type":"string",
            "description":"The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubTypeCode":{
            "title":"Promotion Sub Type",
            "maxLength":30,
            "type":"string",
            "description":"The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligFlg":{
            "title":"Eligibility",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if member is eligible or enrolled.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TypeCodeMeaning":{
            "title":"Promotion Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The type meaning of the promotion which is based on the promotion type code. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Promotion Name",
            "type":"string",
            "description":"The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IncentiveChoice":{
            "title":"Incentive Choice",
            "type":"string",
            "description":"The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no  dependency or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PromotionNumber":{
            "title":"Promotion Number",
            "maxLength":30,
            "type":"string",
            "description":"The promotion number that has been applied to the member during the transaction processing. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EnrollmentStart":{
            "title":"Enrollment Start Date",
            "type":"string",
            "description":"The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PromoMemNumber":{
            "title":"Promotion Member Number",
            "type":"string",
            "description":"The public unique identifier of a member promotion enrolled object which is unique to a given enrollment for a given time period. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubTypeCodeMeaning":{
            "title":"Promotion Sub Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The sub type meaning of the promotion. This is dependent on the promotion type. There is no default value or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the promotion. 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 who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment into an enrollable promotion take place. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top