Jump to

• Request
• Response

Update a point balance (Deprecated)

patch

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances/{LoyAttrdefnBId}

Request

Path Parameters

• LoyAttrdefnBId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : loyaltyMembers-PointBalances-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LoyMemberId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Qualifyingbalance":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FuturePoints":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PointType":{
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Balance":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Lifetimepoints":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top