Jump to

• Request
• Response

Get a member attribute (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberAttributes/{LoyAttribId}

Request

Path Parameters

• LoyAttribId(required): integer(int64)
  The attribute identifier, which is the reference definition identifier of Member Level attributes that are linked in the Member UI page. Do not use this attribute. It is exposed in the resource for reference purpose only. 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 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(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-MemberAttributes-item-response

Type: object

Show Source

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

  The member attribute definition identifier. This attribute is not part of the Oracle Loyalty Cloud Member resource. There is no default value, dependency, or limitation associated with this attribute.
• AttributeName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 30

  The name of the member attribute. It shows the display name of the Member level attribute which is created through the loyalty UI. There is no default value, dependency, or limitation associated with this attribute.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 1

  The member attribute record conflict identifier. This attribute is an Oracle Siebel CRM feature which is replicated in Oracle Loyalty Cloud. It is not applicable to the current release and is set to 0 (zero) for most Oracle Loyalty Cloud entities. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user that creates the member attribute record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
• CreationDate: string (date-time)
  Title: Created Date

  Read Only: true

  The date when the member attribute record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.
• DescriptionText: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The member attribute description text that is provided by the loyalty administrator while creating the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The member attribute record last update date. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The member attribute record last updated by the user. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the 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 member attribute record last updated by the user login. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the 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.
• LoyAttrdefnBId: integer (int64)
  Title: Attribute Definition ID

  Read Only: true

  The attribute definition identifier. This attribute is the internal representation of the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
• LoyAttribId: integer (int64)
  Title: Loyalty Attribute ID

  The attribute identifier, which is the reference definition identifier of Member Level attributes that are linked in the Member UI page. Do not use this attribute. It is exposed in the resource for reference purpose only. There is no default value, dependency, or limitation associated with this attribute.
• MemberId: integer (int64)
  Title: Member ID

  The member identifier for the member level attributes applied to an individual member for the current member record. The MemberId attribute in the MemberAttributes child resource shows that the member level attribute is applied to this current member parent record. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The member attribute record object version number. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Title: Promotion ID

  Read Only: true

  The promotion identifier which is applied when the Oracle Loyalty Cloud engine processes a Member level attribute. There is no default value, dependency, or limitation associated with this attribute.
• Value: string
  Title: Attribute 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 promotions which updates the value of attribute. There is no default value, dependency, or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The member attribute record last updated by the user. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"The date when the member attribute record is created. Oracle Loyalty Cloud sets this date value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user that creates the member attribute record. Oracle Loyalty Cloud populates this value when the loyalty administrator creates the Member level attributes in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "title":"Promotion ID",
            "type":"integer",
            "description":"The promotion identifier which is applied when the Oracle Loyalty Cloud engine processes a Member level attribute. 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
        },
        "LoyAttribId":{
            "title":"Loyalty Attribute ID",
            "type":"integer",
            "description":"The attribute identifier, which is the reference definition identifier of Member Level attributes that are linked in the Member UI page. Do not use this attribute. It is exposed in the resource for reference purpose only. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttribDefnId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The member attribute definition identifier. This attribute is not part of the Oracle Loyalty Cloud Member resource. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The member attribute record conflict identifier. This attribute is an Oracle Siebel CRM feature which is replicated in Oracle Loyalty Cloud. It is not applicable to the current release and is set to 0 (zero) for most Oracle Loyalty Cloud entities. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The member identifier for the member level attributes applied to an individual member for the current member record. The MemberId attribute in the MemberAttributes child resource shows that the member level attribute is applied to this current member parent record. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "title":"Attribute Definition ID",
            "type":"integer",
            "description":"The attribute definition identifier. This attribute is the internal representation of the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The member attribute record object version number. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Attribute 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 promotions which 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"
            }
        },
        "AttributeName":{
            "title":"Display Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the member attribute. It shows the display name of the Member level attribute which is created through the loyalty UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The member attribute description text that is provided by the loyalty administrator while creating the Member level attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The member attribute record last updated by the user login. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The member attribute record last update date. Oracle Loyalty Cloud updates this attribute for the logged in user details when the loyalty administrator updates the details about the Member level attribute in the UI. 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