Home | Index

BOSS API Guide

Prev — Response fields
Chapter 7. Appendix and FAQ's — Next

Chapter 6. Spelling Suggestions

Table of Contents

Response fields

The Spelling request allows you to retrieve spelling suggestions from the spelling database. This chapter explains how the request works, including arguments and their values. It contains the following sections:

[Important] Important

You must escape reserved characters to use them in argument values, although they are sometimes shown unescaped for readability. See “Reserved Characters and Escape Values”.

Spelling syntax: The end user searches on the words "monkeys" and "giraffes". You send the following to the BOSS:

http://boss.yahooapis.com/ysearch/spelling/v1/{query}?appid=xyz&format=xml

BOSS finds a suggestion and returns the following lines in XML, indicating that the new spelling is a suggestion:

<ysearchresponse responsecode="200">
  <resultset_spelling count="1" start="1" totalhits="1" deephits="1">
    <result> 
      <suggestion>monkeys giraffes</suggestion>
    </result>
  </resultset_spelling>
</ysearchresponse>

Response fields

The SPELL request returns the following fields:

Field name Description

suggestion

The actual spelling suggestion.