Search Prior To Customer Escalation

Overview

This API performs search on the subject and description parameters, but filters out any articles that the customer has viewed in the current session.

SecurityoAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
escalationId
required
string <uuid>

The ID of the customer escalation.

Example: f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454
query Parameters
filter[articles-in-topic-tree]
number

This parameter will restrict the search scope to the provided topic and it's sub topic.

Example: filter[articles-in-topic-tree]=202200000001037
$attribute
string

The fields of the article to be returned.

Enum: "articleMacro" "availabilityDate" "averageRating" "contentText" "orderNumber" "suggestionType" "timesRated" "availableEditions" "articleTypeAttributes" "milestone" "all"
Example: $attribute=articleMacro
maxResults
number

The "maxResults" parameter specifies the number of articles that should be included in the response.

It is only required when the escalation type is chat escalation.If not specified then default value 5 will be considered for chat escalation.

If the escalation type is email, the maximum results value specified in the portal settings for email escalation will be taken into consideration.

Example: maxResults=5
$pagenum
string

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
Default value: 1

$pagesize
string

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
Default value: 25

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 25

header Parameters
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

Success

400

Bad Request

401

Unauthorized

403

Forbidden

406

Not acceptable

500

Internal server error

get/portals/{portalID}/escalate/{escalationId}/search
Request samples
Response samples
application/json
{
  • "article": [
    ],
  • "paginationInfo": {
    }
}