API Documentation
Overview
Yahoo! Placemaker is a Web service, accessible at http://wherein.yahooapis.com
Requests to Placemaker are sent as HTTP POST messages, using a URI (Uniform Resource Identifier) to indicate what resource is desired, HTTP headers to provide context for the request, and a message body composed of parameters and the document to be processed.
Resources
A resource identifies an object (commonly referred to as "nouns" in REST terminology). For example, a document is a resource, and a unique URL exists to locate it. A resource is referred to in the singular ('place', 'parent', etc.).
Query Parameters
The Web service supports several parameters (name/value pairs) called "query parameters" that allow users to specify a particular language or format for the response. Query parameters are encoded using one of two encodings: application/x-www-form-urlencoded, or multipart/form-data.
The following query parameters are supported by the Web service:
| Parameter | Resource | Default | Example | Description |
|---|---|---|---|---|
inputLanguage |
|
en-US |
inputLanguage=fr-CA |
Use specified language (RFC 4646) for place name recognition |
outputType |
/document |
xml |
outputType=rss |
Return results in specified format:
|
documentContent |
/document |
(none) |
documentContent=I+live+in+New+York+City |
Input document to be processed |
documentTitle |
/document |
(none) |
documentTitle=News+from+New+York+City |
Title of input document to be processed; only processed for plaintext documents |
documentURL |
|
|
documentURL=http://rss.slashdot/Slashdot/slashdot |
URL of input document to be processed (required if documentContent is not provided) |
documentType |
/document |
(required) |
documentType=text/plain |
MIME document type:
|
autoDisambiguate |
/document |
true |
autoDisambiguate=false |
if true, return only the most likely named place for each place reference |
focusWoeid |
/document |
(none) |
focusWoeid=12345 |
WOEID of named place to be used as a search focus |
appid |
/document |
(required) |
appid=myappid |
Grants authorization to use the web service; required for all requests |
The documentURL parameter is ignored if the documentContent parameter is provided.