Jump to

• Request
• Response
• Examples

Create a membership card collection for a member (Deprecated - See "Create a membership card" in the Loyalty Members resource)

post

/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards

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:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the membership card is active. It accepts the Y and N values. If N is specified, then the membership card details can be edited. There is no default value, dependency, or limitation associated with this attribute.
• CardNumber: string
  Title: Card Number

  Maximum Length: 30

  The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute.
• CardStatus: string
  Title: Card Status

  The Card Status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. It is based on the ORA_LOY_MEM_CARD_STATUS lookup type. The membership card's validity, which depends on the membership card status, start date, and expiry date, can be checked. There is no default value, dependency, or limitation associated with this attribute.
• CardType: string
  Title: Card Type Meaning

  The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. It is based on the ORA_LOY_MEM_CARD_TYPE lookup type. Depending on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value or limitation associated with this attribute.
• CardTypeCode: string
  Title: Card Type

  Maximum Length: 30

  The membership card type code shows the card type detail. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDate: string (date-time)
  Title: Expiration Date

  The date when the membership card expires in the loyalty system. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDateOnCard: string (date-time)
  Title: Expiration Date on Card

  The Expiration Date On Card attribute is the date which specifies to the member when the membership card expires. There is no default value, dependency, or limitation associated with this attribute.
• IssueDate: string (date-time)
  Title: Issued Date

  The date when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.
• LoyCardId: integer (int64)
  Title: Card ID

  The primary key of the membership card referred by current loyaltyMembershipCards resource. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber: string
  Title: Member Number

  Maximum Length: 30

  The Member Number attribute is an alternative identifier that uniquely identifies a member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.
• NameOnCard: string
  Title: Name on Card

  Maximum Length: 50

  The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute.
• RequestDate: string (date-time)
  Title: Requested Date

  The date when a request is placed for generating the membership card. There is no default value, dependency, or limitation associated with this attribute.
• StartDate: string (date-time)
  Title: Start Date

  The date when the membership card is valid. After this date, the card can be used to receive rewards, or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status code of the membership card, which is a read-only value based on the CardStatus attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_CARD_STATUS lookup. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CardNumber":{
            "title":"Card Number",
            "maxLength":"30",
            "type":"string",
            "description":"The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false
        },
        "ExpiryDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the membership card expires in the loyalty system. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false
        },
        "LoyCardId":{
            "title":"Card ID",
            "type":"integer",
            "description":"The primary key of the membership card referred by current loyaltyMembershipCards resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IssueDate":{
            "title":"Issued Date",
            "type":"string",
            "description":"The date when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "CardStatus":{
            "title":"Card Status",
            "type":"string",
            "description":"The Card Status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. It is based on the ORA_LOY_MEM_CARD_STATUS lookup type. The membership card's validity, which depends on the membership card status, start date, and expiry date, can be checked. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the membership card is active. It accepts the Y and N values. If N is specified, then the membership card details can be edited. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the membership card, which is a read-only value based on the CardStatus attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_CARD_STATUS lookup. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CardTypeCode":{
            "title":"Card Type",
            "maxLength":"30",
            "type":"string",
            "description":"The membership card type code shows the card type detail. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the membership card is valid. After this date, the card can be used to receive rewards, or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "RequestDate":{
            "title":"Requested Date",
            "type":"string",
            "description":"The date when a request is placed for generating the membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CardType":{
            "title":"Card Type Meaning",
            "type":"string",
            "description":"The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. It is based on the ORA_LOY_MEM_CARD_TYPE lookup type. Depending on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MemberNumber":{
            "title":"Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The Member Number attribute is an alternative identifier that uniquely identifies a member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NameOnCard":{
            "title":"Name on Card",
            "maxLength":"50",
            "type":"string",
            "description":"The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false
        },
        "ExpiryDateOnCard":{
            "title":"Expiration Date on Card",
            "type":"string",
            "description":"The Expiration Date On Card attribute is the date which specifies to the member when the membership card expires. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

  Indicates whether the membership card is active. It accepts the Y and N values. If N is specified, then the membership card details can be edited. There is no default value, dependency, or limitation associated with this attribute.
• CardNumber: string
  Title: Card Number

  Maximum Length: 30

  The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute.
• CardStatus: string
  Title: Card Status

  The Card Status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. It is based on the ORA_LOY_MEM_CARD_STATUS lookup type. The membership card's validity, which depends on the membership card status, start date, and expiry date, can be checked. There is no default value, dependency, or limitation associated with this attribute.
• CardType: string
  Title: Card Type Meaning

  The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. It is based on the ORA_LOY_MEM_CARD_TYPE lookup type. Depending on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value or limitation associated with this attribute.
• CardTypeCode: string
  Title: Card Type

  Maximum Length: 30

  The membership card type code shows the card type detail. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The details of who created the membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a new membership card. 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 membership card is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new membership card. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDate: string (date-time)
  Title: Expiration Date

  The date when the membership card expires in the loyalty system. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDateOnCard: string (date-time)
  Title: Expiration Date on Card

  The Expiration Date On Card attribute is the date which specifies to the member when the membership card expires. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryStampedOnCard: string
  Read Only: true

  The Expiry Stamped On Card attribute is the date physically stamped on the card which specifies to the member when the membership card expires. Its value is the same as that of the ExpiryDateOnCard attribute, but only specifies the month and year of expiry. There is no default value, dependency, or limitation associated with this attribute.
• IssueDate: string (date-time)
  Title: Issued Date

  The date when the membership card is issued. 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 memberhip card record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the memership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Update By

  Read Only: true

  Maximum Length: 64

  The user that updates the memberhip card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card 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 that updated the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyCardId: integer (int64)
  Title: Card ID

  The primary key of the membership card referred by current loyaltyMembershipCards resource. There is no default value, dependency, or limitation associated with this attribute.
• MemberName: string
  Title: Member Name

  Read Only: true

  Maximum Length: 100

  The identifier specifies the name of the member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.
• MemberNumber: string
  Title: Member Number

  Maximum Length: 30

  The Member Number attribute is an alternative identifier that uniquely identifies a member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.
• MemberStatus: string
  Read Only: true

  The current status of the loyalty member for whom the membership card is issued. The accepted values are Active, InActive, Dormant, and so on. There is no default value, dependency, or limitation associated with this attribute.
• MemberTier: string
  Read Only: true

  The identifier specifies the tier to which the member belongs, for example, Gold, Silver, and so on. A membership card is generated for a member when the member joins a loyalty program, moves to a new tier, or requalifies to the same tier. There is no default value, dependency, or limitation associated with this attribute.
• MemTierNum: string
  Title: Member Tier Number

  Read Only: true

  Maximum Length: 30

  The unique identifier which shows the number of the tier to which the loyalty membership card belongs. There is no default value, dependency, or limitation associated with this attribute.
• NameOnCard: string
  Title: Name on Card

  Maximum Length: 50

  The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The name of the program to which the member belongs and for which the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.
• RequestDate: string (date-time)
  Title: Requested Date

  The date when a request is placed for generating the membership card. There is no default value, dependency, or limitation associated with this attribute.
• StartDate: string (date-time)
  Title: Start Date

  The date when the membership card is valid. After this date, the card can be used to receive rewards, or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status code of the membership card, which is a read-only value based on the CardStatus attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_CARD_STATUS lookup. There is no default value or limitation associated with this attribute.
• TierName: string
  Title: Tier Name

  Read Only: true

  The Tier Name attribute specifies the member???s tier to which the member belongs when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.
• UpdateFlag: boolean
  Read Only: true

  Default Value: true

  The Update Flag attribute indicates if the Membership Card resource can be updated. It accepts the Y and N values. This attribute is defaulted to Y. There is no dependency or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CardNumber":{
            "title":"Card Number",
            "maxLength":"30",
            "type":"string",
            "description":"The primary key to identify a loyalty membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a membership card record. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the membership card is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the membership card expires in the loyalty system. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LoyCardId":{
            "title":"Card ID",
            "type":"integer",
            "description":"The primary key of the membership card referred by current loyaltyMembershipCards resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CardStatus":{
            "title":"Card Status",
            "type":"string",
            "description":"The Card Status attribute specifies the status of the membership card. The possible values are Active, Stolen, Expired, Lost, and so on. It is based on the ORA_LOY_MEM_CARD_STATUS lookup type. The membership card's validity, which depends on the membership card status, start date, and expiry date, can be checked. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the membership card, which is a read-only value based on the CardStatus attribute. This attribute is a lookup type value based on the ORA_LOY_MEM_CARD_STATUS lookup. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CardTypeCode":{
            "title":"Card Type",
            "maxLength":"30",
            "type":"string",
            "description":"The membership card type code shows the card type detail. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the membership card is valid. After this date, the card can be used to receive rewards, or special lounge services, and so on, based on the card type. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"The Update Flag attribute indicates if the Membership Card resource can be updated. It accepts the Y and N values. This attribute is defaulted to Y. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "RequestDate":{
            "title":"Requested Date",
            "type":"string",
            "description":"The date when a request is placed for generating the membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CardType":{
            "title":"Card Type Meaning",
            "type":"string",
            "description":"The attribute specifies the membership card type. The accepted values are Gold, Platinum, Silver, and so on. It is based on the ORA_LOY_MEM_CARD_TYPE lookup type. Depending on the card type, members are entitled to different rewards. For example, in the airline industry, members usually show their membership cards to prove their tier status in order to be able to use special lounges. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MemberNumber":{
            "title":"Member Number",
            "maxLength":"30",
            "type":"string",
            "description":"The Member Number attribute is an alternative identifier that uniquely identifies a member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameOnCard":{
            "title":"Name on Card",
            "maxLength":"50",
            "type":"string",
            "description":"The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberTier":{
            "type":"string",
            "description":"The identifier specifies the tier to which the member belongs, for example, Gold, Silver, and so on. A membership card is generated for a member when the member joins a loyalty program, moves to a new tier, or requalifies to the same tier. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Update By",
            "maxLength":"64",
            "type":"string",
            "description":"The user that updates the memberhip card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The details of who created the membership card. Oracle Loyalty Cloud generates this attribute value during the creation of a new membership card. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryStampedOnCard":{
            "type":"string",
            "description":"The Expiry Stamped On Card attribute is the date physically stamped on the card which specifies to the member when the membership card expires. Its value is the same as that of the ExpiryDateOnCard attribute, but only specifies the month and year of expiry. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issued Date",
            "type":"string",
            "description":"The date when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the program to which the member belongs and for which the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the membership card is active. It accepts the Y and N values. If N is specified, then the membership card details can be edited. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "TierName":{
            "title":"Tier Name",
            "type":"string",
            "description":"The Tier Name attribute specifies the member???s tier to which the member belongs when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberName":{
            "title":"Member Name",
            "maxLength":"100",
            "type":"string",
            "description":"The identifier specifies the name of the member to whom the card belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberStatus":{
            "type":"string",
            "description":"The current status of the loyalty member for whom the membership card is issued. The accepted values are Active, InActive, Dormant, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemTierNum":{
            "title":"Member Tier Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier which shows the number of the tier to which the loyalty membership card belongs. There is no default value, dependency, 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 memberhip card  record is updated. Oracle Loyalty Cloud sets this date value when the loyalty administrator updates the memership card in the Oracle Loyalty Cloud UI. 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 updated the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryDateOnCard":{
            "title":"Expiration Date on Card",
            "type":"string",
            "description":"The Expiration Date On Card attribute is the date which specifies to the member when the membership card expires. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "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

LookupPVOStatusCode

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CARD_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: CardStatus; Target Attribute: Meaning
• Display Attribute: Meaning, LookupCode

LookupPVOtype

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_LOY_MEM_CARD_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: CardType; Target Attribute: Meaning
• Display Attribute: Meaning, LookupCode

MemberPVO1

Operation: /crmRestApi/resources/11.13.18.05/loyMembers

Parameters:

• finder: MemNumSearch%3BMemberNumber%3D{MemberNumber}

The following properties are defined on the LOV link relation:

• Source Attribute: MemberNumber; Target Attribute: MemNum
• Display Attribute: MemNum, LoyMemberId

Back to Top

Examples

This example shows how to create a new Loyalty membership card.

Use POST with the following URI syntax to create the new Loyalty membership card:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyPromotions?finder=PromoSearch;Name=Sun API Redemption

Example of Request Header

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

Example of Request Body

{
	"ExpiryDate" : "2017-06-23T00:00:00-07:00",
	"ExpiryDateOnCard" : "2017-06-22T00:00:00-07:00",
	"NameOnCard" : "John",
	"CardType" : "Platinum",
	"MemberNumber" : "300100111620140",
	"CardStatus" : "In Progress"
}

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -730
content-type -application/vnd.oracle.adf.resourceitem+json
date -Fri, 03 Nov 2017 10:31:51 GMT
etag-"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
keep-alive -timeout=61, max=100
link -<http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943>;rel="self";kind="item";name="loyaltyMembershipCards"
location -http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943
rest-framework-version -1
server -Oracle-HTTP-Server-11g
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005NH6SrdedFw0GLIys1yf0005io00025d

Example of Response Body

{
  "CardNumber" : "300100111738943",
  "CreatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
  "CreationDate" : "2017-11-03T10:31:51+00:00",
  "ExpiryDate" : "2017-06-23T07:00:00+00:00",
  "ExpiryDateOnCard" : "2017-06-22T07:00:00+00:00",
  "IssueDate" : null,
  "LastUpdateDate" : "2017-11-03T10:31:51.417+00:00",
  "LastUpdateLogin" : "5D12029AE4131D52E0530740F00AD82F",
  "LastUpdatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
  "NameOnCard" : "John",
  "RequestDate" : null,
  "StartDate" : null,
  "MemberName" : "KK196 Mem",
  "MemberNumber" : "300100111620140",
  "CardStatus" : "In Progress",
  "TierName" : "Tier2",
  "CardType" : "Platinum",
  "MemberTier" : "Tier2",
  "MemberStatus" : "Active",
  "Active" : "N",
  "ProgramName" : "KK196",
  "ExpiryStampedOnCard" : "06/2017",
  "links" : [ {
    "rel" : "self",
    "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943",
    "name" : "loyaltyMembershipCards",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943",
    "name" : "loyaltyMembershipCards",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "http://example.com:port3/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943/lov/MemberPVO1",
    "name" : "MemberPVO1",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943/lov/LookupPVOStatusCode",
    "name" : "LookupPVOStatusCode",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111738943/lov/LookupPVOtype",
    "name" : "LookupPVOtype",
    "kind" : "collection"
  } ]
}

Back to Top