# Event For Viewed Federated Search Result

## Overview
   The Federated Search Event API creates an event for federated search results that have been viewed.
  An event for viewing an: 
  * External web page cannot be created for a portal where the value for the "Include Web Search Section in Search Results" attribute is "Yes".
  * Internal web page cannot be created for a portal where the value for the "Include Intranet Search Section in Search Results" attribute is "Yes".

Endpoint: POST /portals/{portalID}/search/federated/event
Security: oAuthUser, oAuthOnBehalfOfUser, oAuthCustomer, oAuthOnBehalfOfCustomer, oAuthAnonymousCustomer

## Header parameters:

  - `x-egain-activity-id` (string)
    A unique numeric interaction identifier from eGain.
    Example: "59237"

  - `x-ext-integration-id` (string)
    The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

  - `x-ext-interaction-id` (string)
    A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.

  - `Content-Type` (string, required)
    The media type sent by the client.
    Enum: "application/json"

  - `Accept-Language` (string, required)
    The Language locale accepted by the 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"

## Path parameters:

  - `portalID` (string, required)
    The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
    Example: "PROD-1000"

## Request fields (application/json):

  - `q` (string, required)
    The search string that was entered by the user
    Example: "India"

  - `resultType` (string, required)
    Only "external" or "internal" allowed
    Enum: "external", "internal"

  - `url` (string, required)
    Example: "https://egain.com/"

  - `title` (string, required)
    Example: "Welcome to eGain"

  - `languageCode` (string, required)
    A short language code. A list of codes can be found below:

|Code|Description
|----|----------- 
|en-US|English (United States)
|en-GB|English (United Kingdom)
|fr-FR|French (France)
|es-ES|Spanish (Spain)
|it-IT|Italian (Italy)
|de-DE|German (Germany)
|nl-NL|Dutch (Netherlands)
|pt-BR|Portuguese (Brazil)
|pt-PT|Portuguese (Portugal)
|da-DK|Danish (Denmark)
|sv-SE|Swedish (Sweden)
|ru-RU|Russian (Russia)
|fr-CA|French (Canada)
|zh-CN|Chinese (Simplified, China)
|ja-JP|Japanese (Japan)
|ko-KR|Korean (South Korea)
|nn-NO|Norwegian Nynorsk (Norway)
    Enum: "en-US", "en-GB", "fr-FR", "es-ES", "it-IT", "de-DE", "nl-NL", "pt-BR", "pt-PT", "da-DK", "sv-SE", "ru-RU", "fr-CA", "zh-CN", "ja-JP", "ko-KR", "nn-NO"

## Response 400 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 401 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 403 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 404 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 406 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.

## Response 500 fields (application/json):

  - `code` (string, required)
    A string that follows the pattern {integer}-{integer}.

The first {integer} is the http status code.  This code as a whole is unique.
* For example, error codes "400-101" and "404-101" are distinctly different.

  - `developerMessage` (string, required)
    A summary of the error.

  - `details` (array)

  - `details.key` (string, required)

  - `details.value` (string)

  - `userMessage` (string)
    UI friendly messages are only supported by some APIs.  
   The client must explicitly request UI friendly messages by passing the X-egain-error-message=yes* header.


## Response 204 fields

## Response 415 fields