Jump to

• Request
• Response

Get a member attribute

get

/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberAttributes/{MemberAttributesUniqID}

Request

Path Parameters

• MemberAttributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LoyAttribId and LoyAttrdefnBId ---for the Member Attributes resource and used to uniquely identify an instance of Member Attributes. The client should not generate the hash key value. Instead, the client should query on the Member Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Member Attributes.
  
  For example: MemberAttributes?q=LoyAttribId=<value1>;LoyAttrdefnBId=<value2>
• 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.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : loyMembers-MemberAttributes-item-response

Type: object

Show Source

• AttribDefnId: integer (int64)
  Title: Attribute Definition ID

  The attribute definition identifier of the member attribute. This is the identifier for the point type definition. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Created On

  Read Only: true

  The date when the member attribute was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.
• DescText: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description which gives information about the member attribute. There is no default value, dependency, or limitation associated with this attribute.
• DisplayName: string
  Title: Attribute Name

  Read Only: true

  Maximum Length: 30

  The display name of the member attribute definition. There is no default value , dependency or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Updated On

  Read Only: true

  The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the member attribute 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 member attribute. This is the identifier for point type definition. There is no default value, dependency, or limitation associated with this attribute.
• LoyAttribId: integer (int64)
  Title: Loyalty Attribute ID

  The primary key of the member attribute object. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  The member identifier to which this member attribute belongs. There is no default value, dependency, or limitation associated with this attribute.
• ProgramId: integer (int64)
  Read Only: true

  The program unique identifier which this member attribute is associated with. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Read Only: true

  The promotion unique identifier which this member attribute is associated with. There is no default value, dependency, or limitation associated with this attribute.
• Value: string
  Title: Value

  Maximum Length: 250

  The member attribute value after the Oracle Loyalty Cloud engine updates the member-level attribute value based on bucket processing or by applying loyalty promotions that updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"The date when the member attribute was created. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The member identifier to which this member attribute belongs. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DescText":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description which gives information about the member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "type":"integer",
            "description":"The promotion unique identifier  which this member attribute is associated with. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "type":"integer",
            "description":"The attribute definition identifier of the member attribute. This is the 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
        },
        "LoyAttribId":{
            "title":"Loyalty Attribute ID",
            "type":"integer",
            "description":"The primary key of the member attribute object. Oracle Loyalty Cloud generates this attribute value during the creation of a new member attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Attribute Name",
            "maxLength":"30",
            "type":"string",
            "description":"The display name of the member attribute definition. There is no default value , dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Value",
            "maxLength":"250",
            "type":"string",
            "description":"The member attribute value after the Oracle Loyalty Cloud engine updates the member-level attribute value based on bucket processing or by applying loyalty promotions that updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramId":{
            "type":"integer",
            "description":"The program unique identifier which this member attribute is associated with. 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
        },
        "AttribDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The attribute definition identifier of the member attribute. This is the identifier for the point type definition. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Updated On",
            "type":"string",
            "description":"The date when the voucher was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the member attribute There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "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