Get a loyalty membership card that is assigned to a member

get

/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/{CardNumber}

Request

Path Parameters
  • 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.
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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 search Loyalty membership cards based on Member Number and Card Type, where Member Number is a mandatory input parameter and Card Type is an optional input parameter.

Use GET with the following URI syntax to redeem the catalog of product redemptions:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards?finder=MembershipCardSearch;MemberNumber=300100111620140,CardType= "Platinum"

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -1325
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Fri, 03 Nov 2017 10:02:40 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-11g
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005NH4oVa3jFw0GLIys1yf0005io00022k

Example of Response Body

{
  "items" : [ {
    "CardNumber" : "300100111732917",
    "CreatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
    "CreationDate" : "2017-11-02T07:14:25+00:00",
    "ExpiryDate" : "2017-06-23T07:00:00+00:00",
    "ExpiryDateOnCard" : "2017-05-22T07:00:00+00:00",
    "IssueDate" : null,
    "LastUpdateDate" : "2017-11-02T07:14:32.542+00:00",
    "LastUpdateLogin" : "5CF0ECBEB1800A5FE0530740F00AF9FC",
    "LastUpdatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
    "NameOnCard" : "John",
    "RequestDate" : null,
    "StartDate" : null,
    "MemberName" : "KK196 Mem",
    "MemberNumber" : "300100111620140",
    "CardStatus" : null,
    "TierName" : "Tier2",
    "CardType" : "Platinum",
    "MemberTier" : "Tier2",
    "MemberStatus" : "Active",
    "Active" : "Y",
    "ProgramName" : "KK196",
    "ExpiryStampedOnCard" : "05/2017",
    "links" : [ {
      "rel" : "self",
      "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111732917",
      "name" : "loyaltyMembershipCards",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    }, {
      "rel" : "canonical",
      "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111732917",
      "name" : "loyaltyMembershipCards",
      "kind" : "item"
    }, {
      "rel" : "lov",
      "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111732917/lov/MemberPVO1",
      "name" : "MemberPVO1",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111732917/lov/LookupPVOStatusCode",
      "name" : "LookupPVOStatusCode",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "http://example.com:port/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/300100111732917/lov/LookupPVOtype",
      "name" : "LookupPVOtype",
      "kind" : "collection"
    } ]
}
Back to Top