Update a membership card
patch
/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards/{LoyCardId}
Request
Path Parameters
-
LoyCardId(required): integer(int64)
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.
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. 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
The attribute indicates whether a member card is active or inactive. There is no default value, dependency, nor 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. Oracle Loyalty Cloud checks the membership card validity during accrual processing or when the membership card is being used for any rewards, based on the membership card status and the expiry date. 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. Based 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, dependency, or limitation associated with this attribute. -
CardTypeCode: string
Title:
Card Type
Maximum Length:30
The member card type code which shows values based on lookup type ORA_LOY_MEM_CARD_TYPE. There is no default value or limitation associated with this attribute. -
ExpiryDate: string
(date-time)
Title:
Expiration Date
The expiry date attribute specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDateOnCard: string
(date-time)
Title:
Expiration Date on Card
The expiration date displayed on the card that specifies 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 issue date attribute specifies 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 receiving 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 when 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 member card status code which shows values based on ORA_LOY_MEM_CARD_STATUS. 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 : loyMembers-cards-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
The attribute indicates whether a member card is active or inactive. There is no default value, dependency, nor 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. Oracle Loyalty Cloud checks the membership card validity during accrual processing or when the membership card is being used for any rewards, based on the membership card status and the expiry date. 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. Based 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, dependency, or limitation associated with this attribute. -
CardTypeCode: string
Title:
Card Type
Maximum Length:30
The member card type code which shows values based on lookup type ORA_LOY_MEM_CARD_TYPE. There is no default value or limitation associated with this attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that creates the membership card record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the membership card in the Oracle Loyalty Cloud UI. 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 record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the membership card in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDate: string
(date-time)
Title:
Expiration Date
The expiry date attribute specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryDateOnCard: string
(date-time)
Title:
Expiration Date on Card
The expiration date displayed on the card that specifies when the membership card expires. There is no default value, dependency, or limitation associated with this attribute. -
ExpiryStampedOnCard: string
Read Only:
true
The expiration date displayed on the card that specifies 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 issue date attribute specifies 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 membership card record is updated. Oracle Loyalty Cloud sets this date 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
Title:
Last Update By
Read Only:true
Maximum Length:64
The user that updates 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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of 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 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. -
MemberName: string
Title:
Member Name
Read Only:true
Maximum Length:100
The identifier specifies the name of the loyalty member. 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 loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
MemberStatus: string
Read Only:
true
The status of the loyalty member. 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. Oracle Loyalty Cloud generates a membership card for a member when the member joins a loyalty program. 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 loyalty program in which the current loyalty member is enrolled. 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 receiving 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 when 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 member card status code which shows values based on ORA_LOY_MEM_CARD_STATUS. There is no default value or limitation associated with this attribute. -
TierName: string
Title:
Tier Name
Read Only:true
The tier name specifies the member???s tier, for the member to whom 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 flag which indicates integrating user whether current row of information is updatable or not. This is an Oracle Sales Cloud wide field and is a required field for the REST API. There is no default value, 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 list of status codes for membership cards.
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 list of type codes for membership cards.
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 list of members specified for membership cards.
The following properties are defined on the LOV link relation:- Source Attribute: MemberNumber; Target Attribute: MemNum
- Display Attribute: MemNum, LoyMemberId
- finder: