Jump to

• Request
• Response
• Examples

Create a loyalty promotion enrollment collection for a member (Deprecated)

post

/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• EnrollmentEnd: string (date-time)
  Title: Member Enrollment End Date in Promotion.

  The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.
• EnrollmentStart: string (date-time)
  Title: Promotion Enrollment Date

  The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.
• LoyPromomemId: integer (int64)
  Title: Loyalty Promotion Member ID

  The promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber: string
  Title: Member Number

  The unique identifier of a loyalty member. This attribute specifies the member that is being enrolled into the promotion. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Title: Promotion Name

  The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "EnrollmentEnd":{
            "title":"Member Enrollment End Date in Promotion.",
            "type":"string",
            "description":"The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "PromotionName":{
            "title":"Promotion Name",
            "type":"string",
            "description":"The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LoyPromomemId":{
            "title":"Loyalty Promotion Member ID",
            "type":"integer",
            "description":"The promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "EnrollmentStart":{
            "title":"Promotion Enrollment Date",
            "type":"string",
            "description":"The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "type":"string",
            "description":"The unique identifier of a loyalty member. This attribute specifies the member that is being enrolled into the promotion. There is no default value, dependency, or limitation \nassociated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : loyaltyMemberEnrollments-item-response

Type: object

Show Source

• Active: string
  Title: Active

  Read Only: true

  Maximum Length: 1

  The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
• EnrollmentEnd: string (date-time)
  Title: Member Enrollment End Date in Promotion.

  The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.
• EnrollmentStart: string (date-time)
  Title: Promotion Enrollment Date

  The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value 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 promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber: string
  Title: Member Number

  The unique identifier of a loyalty member. This attribute specifies the member that is being enrolled into the promotion. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.
• PromotionName: string
  Title: Promotion Name

  The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute.
• PromotionSubType: string
  Read Only: true

  The promotion sub type details, which are based on the Promotion Type attribute. The accepted values are Manual Credit, Product, and so on. There is no default value, dependency, or limitation associated with this attribute.
• PromotionType: string
  Read Only: true

  The type of promotion to which the member is enrolled. The accepted values are Accrual, Redemption, or Tier. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "EnrollmentEnd":{
            "title":"Member Enrollment End Date in Promotion.",
            "type":"string",
            "description":"The date when members can no longer enroll into the promotion, if the promotion requires enrollment. The enrollment end date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Active":{
            "title":"Active",
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionType":{
            "type":"string",
            "description":"The type of promotion to which the member is enrolled. The accepted values are Accrual, Redemption, or Tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionName":{
            "title":"Promotion Name",
            "type":"string",
            "description":"The name of the promotion, which can be easily remembered by the user. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LoyPromomemId":{
            "title":"Loyalty Promotion Member ID",
            "type":"integer",
            "description":"The promotion member identifier is the primary key of loyalty member enrollments. Oracle Loyalty Cloud generates this attribute value during member enrollment record creation. 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
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is an attribute set by Oracle Loyalty Cloud. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EnrollmentStart":{
            "title":"Promotion Enrollment Date",
            "type":"string",
            "description":"The date when members can enroll into the promotion, if the promotion requires enrollment. The enrollment start date must fall within the promotion???s start and end dates. There is no default value associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MemberNumber":{
            "title":"Member Number",
            "type":"string",
            "description":"The unique identifier of a loyalty member. This attribute specifies the member that is being enrolled into the promotion. There is no default value, dependency, or limitation \nassociated with this attribute.",
            "nullable":true,
            "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"
            }
        },
        "PromotionSubType":{
            "type":"string",
            "description":"The promotion sub type details, which are based on the Promotion Type attribute. The accepted values are Manual Credit, Product, and so on. 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

Examples

This example shows how to enrol a member into a promotion.

Use POST with the following URI syntax to enrol a member into a promotion:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/

Example of Request Header

Name: Content-Type
Value: application/vnd.oracle.adf.resourceitem+json

Example of Request Body

{ 
 "EnrollmentEnd": "2017-09-15T05:47:35.135-07:00",
 "EnrollmentStart": "2017-09-12T05:47:35.135-07:00",
 "MemberNumber": "300100091233747",
 "PromotionName": "zaheerenrollablepromoseptone"
}

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
content-encoding -gzip
content-length -563
content-type -application/vnd.oracle.adf.resourceitem+json
date -Mon, 06 Nov 2017 08:55:18 GMT
etag-"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
link -<example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734>;rel="self";kind="item";name="loyaltyMemberEnrollments"
location -example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734
rest-framework-version -1
x-oracle-dms-ecid -539eb9a8ae5b64a8:598408c4:15f76dedb28:-8000-0000000000134c7d
x-powered-by -Servlet/2.5 JSP/2.1

Example of Response Body

{
  "EnrollmentEnd" : "2017-09-15T05:47:35.135-07:00",
  "EnrollmentStart" : "2017-09-12T05:47:35.135-07:00",
  "LoyPromomemId" : 300100092755734,
  "ObjectVersionNumber" : 1,
  "Active" : "Y",
  "MemberNumber" : "300100091233747",
  "PromotionName" : "zaheerenrollablepromoseptone",
  "PromotionType" : "Accrual",
  "PromotionSubType" : "Manual Credit",
  "links" : [ {
    "rel" : "self",
    "href" : "example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734",
    "name" : "loyaltyMemberEnrollments",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734",
    "name" : "loyaltyMemberEnrollments",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734/lov/PromotionPVO1",
    "name" : "PromotionPVO1",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/300100092755734/lov/MemberPVO1",
    "name" : "MemberPVO1",
    "kind" : "collection"
  } ]
}

Back to Top