Update a loyalty membership card that is assigned to a member (Deprecated - See "Update a membership card" in the Loyalty Members resource)
patch
/crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/{CardNumber}
Request
Path Parameters
-
CardNumber(required): 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.
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.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
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. -
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. -
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.
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.
Root Schema : loyaltyMembershipCards-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- LookupPVOStatusCode
-
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
- finder:
- LookupPVOtype
-
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
- finder:
- MemberPVO1
-
Operation: /crmRestApi/resources/11.13.18.05/loyMembersParameters:
- 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
- finder:
Examples
This example shows how to update a loyalty membership card that is assigned to a member.
Use PATCH with the following URI syntax to update membership card number 300100125114820 to a card type of Silver:
https://example.com:port/crmRestApi/resources/11.13.18.05/oyaltyMembershipCards/300100125114820
Example of Request Body
{
"CardType" : "Silver"
}
Example of Response Header
cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -734
content-type -application/vnd.oracle.adf.resourceitem+json
date -Thu, 29 Mar 2018 14:18:26 GMT
etag -"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
keep-alive -timeout=61, max=100
link -<https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820>;rel="self";kind="item";name="loyaltyMembershipCards"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005Q8rC2B^tEoIILIqL6if0007EH0004l8
Example of Response Body
{
"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-29T14:18:09+00:00",
"LastUpdateLogin" : "687CA86E85E3E6A3E05334C4F00A0C3D",
"LastUpdatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
"NameOnCard" : "KK Member",
"RequestDate" : "2018-03-07T11:03:13.929+00:00",
"StartDate" : "2018-03-07T11:03:13.929+00:00",
"MemberName" : "KK Member",
"MemberNumber" : "300100125114773",
"CardStatus" : "Active",
"TierName" : "Silver",
"CardType" : "Silver",
"MemberTier" : "Base",
"MemberStatus" : "Active",
"Active" : "N",
"ProgramName" : "KKProgram",
"ExpiryStampedOnCard" : "03/2018",
"UpdateFlag" : "true",
"links" : [ {
"rel" : "self",
"href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820",
"name" : "loyaltyMembershipCards",
"kind" : "item",
"properties" : {
"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
}, {
"rel" : "canonical",
"href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820",
"name" : "loyaltyMembershipCards",
"kind" : "item"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820/lov/MemberPVO1",
"name" : "MemberPVO1",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820/lov/LookupPVOStatusCode",
"name" : "LookupPVOStatusCode",
"kind" : "collection"
}, {
"rel" : "lov",
"href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyMembershipCards/300100125114820/lov/LookupPVOtype",
"name" : "LookupPVOtype",
"kind" : "collection"
} ]
}