1. REST API for Oracle Loyalty Cloud
  2. Tasks
  3. Loyalty Membership Cards

Get all loyalty membership cards that are assigned to a member

get

/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • MemberCardTypeSearch: Finds a membership card for a specified card type and member number.
      Finder Variables:
      • CardType; string; The membership card type.
      • MemberNumber; string; The member number.
    • MembershipCardSearch: Finds a membership card for the specified card number, expiry date, expiry date on card, card issue date, name on card, request date, card start date, card status, card type, member name, member status, membet tier, member number, tier name, card active status or program name.
      Finder Variables:
      • Active; string; The membership card active status.
      • CardNumber; string; The membership card number.
      • CardStatus; string; The membership card status.
      • CardType; string; The membership card type.
      • ExpiryDate; string; The membership card expiry date.
      • ExpiryDateOnCard; string; The membership card expiry date on the card.
      • IssueDate; string; The membership card issue date.
      • MemberName; string; The member name.
      • MemberNumber; string; The member number.
      • MemberStatus; string; The member status.
      • MemberTier; string; The member tier.
      • NameOnCard; string; The membership card name on the card.
      • ProgramName; string; The loyalty program name.
      • RequestDate; string; The membership card request date.
      • StartDate; string; The membership card start date.
      • TierName; string; The tier name.
    • MembershipCardUpdate: Finds a membership card for a specified card number.
      Finder Variables:
      • CardNumber; string; The membership card number.
    • PrimaryKey: Find a membership card for a specified primary key.
      Finder Variables:
      • LoyCardId; integer; The loyalty card identifier.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ActiveFlag; boolean; 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; 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.
    • CardTypeCode; string; The membership card type code shows the card type detail. There is no default value, dependency, or limitation associated with this attribute.
    • CreatedBy; string; 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; 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; 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; 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; 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; The date when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.
    • LastUpdateDate; string; 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.
    • LastUpdateLogin; string; 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.
    • LastUpdatedBy; string; 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.
    • LoyCardId; integer; The primary key of the membership card referred by current loyaltyMembershipCards resource. There is no default value, dependency, or limitation associated with this attribute.
    • MemTierNum; string; 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.
    • MemberName; string; 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; 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; 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; 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.
    • NameOnCard; string; The member name that is displayed on the membership card. There is no default value, dependency, or limitation associated with this attribute.
    • ProgramName; string; 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.
    • StartDate; string; 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; 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.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : loyaltyMembershipCards-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Issued Date
    The date when the membership card is issued. There is no default value, dependency, or limitation associated with this attribute.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top

Examples

This example shows how to retrieve all the membership cards in the loyalty system.

Use GET with the following URI syntax to retrieve all membership cards:

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

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -3257
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Tue, 13 Mar 2018 18:52:09 GMT
keep-alive -timeout=61, max=100
link -<https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards>;rel="self";kind="collection";name="loyaltyMembershipCards"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005Poz1UH0PEoIILIqL6if0007EH000Di1

Example of Response Body

{
    "items": [
        {
            "CardNumber": "300100125114820",
            "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "CreationDate": "2018-03-07T11:03:16.610+00:00",
            "ExpiryDate": "2018-03-07T11:03:20.534+00:00",
            "ExpiryDateOnCard": "2018-03-07T11:03:20.534+00:00",
            "IssueDate": "2018-03-07T11:03:13.929+00:00",
            "LastUpdateDate": "2018-03-07T11:03:16.786+00:00",
            "LastUpdateLogin": "66D1758A5181EC3FE05334C4F00A4060",
            "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "NameOnCard": "ABC Member",
            "RequestDate": "2018-03-07T11:03:13.929+00:00",
            "StartDate": "2018-03-07T11:03:13.929+00:00",
            "MemberName": "ABC Member",
            "MemberNumber": "300100125114773",
            "CardStatus": "Active",
            "TierName": "Silver",
            "CardType": "Silver",
            "MemberTier": "Base",
            "MemberStatus": "Active",
            "Active": "N",
            "ProgramName": "ABCProgram",
            "ExpiryStampedOnCard": "03/2018",
            "UpdateFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125114820",
                    "name": "loyaltyMembershipCards",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125114820",
                    "name": "loyaltyMembershipCards",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125114820/lov/MemberPVO1",
                    "name": "MemberPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125114820/lov/LookupPVOStatusCode",
                    "name": "LookupPVOStatusCode",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125114820/lov/LookupPVOtype",
                    "name": "LookupPVOtype",
                    "kind": "collection"
                }
            ]
        },
.
.
.
        {
            "CardNumber": "300100125170206",
            "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "CreationDate": "2018-03-12T03:29:00.037+00:00",
            "ExpiryDate": "2020-03-12T03:29:07.395+00:00",
            "ExpiryDateOnCard": "2020-03-12T03:29:07.395+00:00",
            "IssueDate": "2018-03-12T03:29:07.395+00:00",
            "LastUpdateDate": "2018-03-12T03:29:00.173+00:00",
            "LastUpdateLogin": "672EC797F0F83DEBE05334C4F00AD631",
            "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "NameOnCard": "John Black",
            "RequestDate": "2018-03-12T03:29:07.395+00:00",
            "StartDate": "2018-03-12T03:29:07.395+00:00",
            "MemberName": "John Black",
            "MemberNumber": "300100125170176",
            "CardStatus": "Active",
            "TierName": "Tier 1",
            "CardType": "Silver",
            "MemberTier": "Tier 1",
            "MemberStatus": "Active",
            "Active": "N",
            "ProgramName": "Better Rewards",
            "ExpiryStampedOnCard": "03/2020",
            "UpdateFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125170206",
                    "name": "loyaltyMembershipCards",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125170206",
                    "name": "loyaltyMembershipCards",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125170206/lov/MemberPVO1",
                    "name": "MemberPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125170206/lov/LookupPVOStatusCode",
                    "name": "LookupPVOStatusCode",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100125170206/lov/LookupPVOtype",
                    "name": "LookupPVOtype",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 22,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https:example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards",
            "name": "loyaltyMembershipCards",
            "kind": "collection"
        }
    ]
}
Back to Top