Get Customer Attributes

Overview

Use this API to retrieve metadata for attributes of customer resource.

Permissions

Actor Permission
User No additional permission is required.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
query Parameters
$attribute
required
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Available values: type, country, industry, level, contacts, custom, all

  • type: type: Returns metadata for type and region attributes of customer resource. The specific attributes are:
    • group.type: Available group types
    • group.region: Regions configured in application for the customer resource
    • corporate.region: Regions configured in application for corporate customer
  • country: Returns the list of the countries configured in application.
  • industry: Returns the list of the industries configured in application.
  • level: Returns the list of the levels configured in application.
  • contacts: Returns metadata for attributes of contacts. Metadata of the following attributes of contacts is returned:
    • contact.type: Types of contacts configured in the application.
    • contact.identification.type: Types of identification for contact configured in the application.
    • contact.contactPoints.contactPoint: Metadata information of the custom attributes configured for a contact point in the application.
    • Custom attributes of the contact.
  • custom: Returns the custom attributes configured for customer resource.
  • all: All the supported attributes are returned.

At least one of these values must be provided for $attribute.

Examples:
Custom attributes configured for customer resource are returned in server response.
$attribute=custom
All the attributes are returned in server response.
$attribute=all
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

204

No content

400

Bad Request message

401

Unauthorized

403

Forbidden

406

Not Acceptable

500

Internal server error

get/customer/attributes
Request samples
Response samples
application/json
    

  • GET /core/customermgr/v3/customer/attributes?$attribute=type
    • 

  • This example demonstrates the following:
      

    • Retrieve the details of the "type" attribute of the customer resource.
      • 

    

    • 



{
  • "attribute": [
    ],
  • "resource": "customer"
}