Create a point balance (Deprecated)
post
/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances
Request
Path Parameters
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a 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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
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 : loyaltyMembers-PointBalances-item-response
Type:
Show Source
object
-
Balance: number
Read Only:
true
The point balance. This attribute is the numeric value of the point balance of the point type. There is no default value, dependency, or limitation associated with this attribute. -
FuturePoints: number
Read Only:
true
The member's remaining points, which are available for future use and on maturity are added into the member's available balance. There is no default value, dependency, or limitation associated with this attribute. -
Lifetimepoints: number
Read Only:
true
The member's lifetime point balance, which is the high watermark of the member's point balance. 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. -
LoyAttrdefnBId: integer
(int64)
Read Only:
true
The attribute definition identifier of the point balance. This attribute is the internal identifier for Point Type definition. There is no default value, dependency, or limitation associated with this attribute. -
LoyMemberId: integer
(int64)
Read Only:
true
The member identifier of the point balance. This attribute is the member's primary key identifier for which the point balance is displayed. There is no default value, dependency, or limitation associated with this attribute. -
PointType: string
Read Only:
true
Maximum Length:255
The point type of the point balance. The point balance is displayed as a child resource under the loyalty Members resource. A member can have a point balance related to multiple point types. There is no default value, dependency, or limitation associated with this attribute. -
Qualifyingbalance: number
Read Only:
true
The member qualifying point balance. Oracle Loyalty Cloud uses the qualifying point type's point balance for tier assessment. 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.