BreadcrumbConfig

The request for breadcrumbs is implemented with the BreadcrumbConfig type.

The BreadcrumbConfig type has this syntax:

<BreadcrumbConfig Id="?" ReturnFullPath="true">
   <StateName>?</StateName>
</BreadcrumbConfig>

The attributes are:

Attribute	Description
`Id`	Required. An arbitrary identifier for this BreadcrumbConfig.
`ReturnFullPath`	Optional. Specifies whether to return the full path of all suggested hierarchical refinements with the response: If set to `true`, the returned breadcrumb contains the full path to its parent refinement values, as in `Wine > Red > Merlot`. If set to `false`, returns only the refinement, without the path to its ancestors. If not specified, the default is `false`. This setting is relevant only in navigation queries that request breadcrumbs; it is ignored in search or range filter queries requesting breadcrumbs.
`StateName`	Specifies an existing named state in the request, using these rules: If the request has multiple named states, then the `StateName` element must reference one (and only one) of the named states. If the request has only one named state, then it is optional as to whether the `StateName` element is used to reference that named state (as the state will be used in any event in the BreadcrumbConfig). If the request has an unnamed state, then the `StateName` element cannot be used.

Attribute

Description

Id

Required. An arbitrary identifier for this BreadcrumbConfig.

ReturnFullPath

Optional. Specifies whether to return the full path of all suggested hierarchical refinements with the response:

If set to true, the returned breadcrumb contains the full path to its parent refinement values, as in Wine > Red > Merlot.
If set to false, returns only the refinement, without the path to its ancestors. If not specified, the default is false.

This setting is relevant only in navigation queries that request breadcrumbs; it is ignored in search or range filter queries requesting breadcrumbs.

StateName

Specifies an existing named state in the request, using these rules:

If the request has multiple named states, then the StateName element must reference one (and only one) of the named states.
If the request has only one named state, then it is optional as to whether the StateName element is used to reference that named state (as the state will be used in any event in the BreadcrumbConfig).
If the request has an unnamed state, then the StateName element cannot be used.

Adding supplemental information

If spelling is enabled in the data domain configuration, and in addition to breadcrumbs, you may want the Conversation Web Service response to contain supplemental information about spelling suggestions and DYM (Did You Mean), a second SearchAdjustmentConfig type is required. If this type is included, spelling correction or DYM suggestions are returned with the breadcrumbs in the response.

If spelling is enabled, spelling correction occurs for breadcrumb results even if the SearchAdjustmentConfig is not included. However, while spelling correction takes place, the spelling correction and DYM suggestions are not returned in the response.

In the response, breadcrumbs are returned in the order in which they were added (requested).