Get Customer Attributes
Overview
This API allows a user to retrieve metadata for attributes of customer resource.
- Since
- 11.6
APIs
| Method | URL | Description |
| GET | /ws/v12/interaction/customer/attributes | Retrieve attribute metadata for customer resource. |
Authentication
Authentication is required. The client must be logged in to call this API. Each API request must contain X-egain-session request header returned by Login API.
Permissions
No permissions are required.
Licenses
The logged in user must have the following licenses:
Request
Request headers
| Name | Description | Allowed values | Default value |
| X-egain-session | Session ID obtained from Login API response header | N/A | N/A |
| Accept | Content type accepted by client | application/xml or application/json | N/A |
| Accept-Language | Language locale accepted by client (used for locale specific fields in resource representation and in error responses) | Supported 'Accept-Language' header codes | default system language |
Supported API specific query parameters
None
Supported common query parameters
One of the following values must be provided for $attribute query parameter:
- 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.
- contactPersons: Returns metadata for attributes of contactPersons. Metadata of the following attributes of contactPersons is returned:
-
contactPerson.type: Types of contact persons configured in the application.
-
contactPerson.identification.type: Types of identification for contact person configured in the application.
-
contactPerson.contactPoints.contactPoint: Metadata information of the custom attributes configured for a contact point in the application.
-
Custom attributes of the contact Person.
- custom: Returns the custom attributes configured for customer resource.
- all: This attribute has a special meaning. If this is specified, all the supported attributes are returned.
Response
Response headers
| Name | Description | Possible values |
| X-egain-session | Session ID of the current user session | N/A |
| Content-Type | Media type of response body | application/xml or application/json |
Response body
The response body can be in either XML or JSON format.
Response body XML schemas:
- schema-common-Attributes - used in case of success
- schema-kb-WSError - used in case of error
HTTP status codes
Success Status codes
200 - OK
- The request executed successfully.
204 - No content
- No content to return. For example, if only custom attributes are requested, and no custom attributes are configured for the customer resource.
Failure Status codes
400 - Bad Request
- Unsupported query parameter is sent in request URL.
- Required common query parameter is not provided. Refer the section "Supported common query parameters" for more details.
401 - Unauthorized
- X-egain-session request header is missing.
- Session is invalid or expired.
406 - Not Acceptable
- Invalid 'Accept-Language' header value.
500 - Internal server error
Examples:
Example 1 - Get metadata for an attribute
Example 2 - Get metadata for multiple attributes
Example 3 - Get metadata for all attributes
