Examples

Example 1. Retrieving Places for a Given Place Name Using XML Response

Request URI and Parameters:

Response Data:

<?xml version="1.0" encoding="utf-8"?>
<contentlocation xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" xmlns="http://wherein.yahooapis.com/v1/schema" xml:lang="en">
  <processingTime>0.001843</processingTime>
  <version> build 101006</version>
  <documentLength>12</documentLength>
  <document>
    <administrativeScope>
      <woeId>2502265</woeId>
      <type>Town</type>
      <name><![CDATA[Sunnyvale, CA, US]]></name>
      <centroid>
        <latitude>37.3716</latitude>
        <longitude>-122.038</longitude>
      </centroid>
    </administrativeScope>
    <geographicScope>
      <woeId>2502265</woeId>
      <type>Town</type>
      <name><![CDATA[Sunnyvale, CA, US]]></name>
      <centroid>
        <latitude>37.3716</latitude>
        <longitude>-122.038</longitude>
      </centroid>
    </geographicScope>
    <localScopes>
      <localScope>
        <woeId>2502265</woeId>
        <type>Town</type>
        <name><![CDATA[Sunnyvale, CA, US (Town)]]></name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
        <ancestors>
          <ancestor>
            <woeId>12587712</woeId>
            <type>County</type>
            <name><![CDATA[Santa Clara]]></name>
          </ancestor>
          <ancestor>
            <woeId>2347563</woeId>
            <type>State</type>
            <name><![CDATA[California]]></name>
          </ancestor>
          <ancestor>
            <woeId>23424977</woeId>
            <type>Country</type>
            <name><![CDATA[United States]]></name>
          </ancestor>
        </ancestors>
      </localScope>
    </localScopes>
    <extents>
      <center>
        <latitude>37.3716</latitude>
        <longitude>-122.038</longitude>
      </center>
      <southWest>
        <latitude>37.3316</latitude>
        <longitude>-122.081</longitude>
      </southWest>
      <northEast>
        <latitude>37.4518</latitude>
        <longitude>-121.979</longitude>
      </northEast>
    </extents>
    <placeDetails>
      <placeId>1</placeId>
      <place>
        <woeId>2502265</woeId>
        <type>Town</type>
        <name><![CDATA[Sunnyvale, CA, US]]></name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
      </place>
      <placeReferenceIds>1</placeReferenceIds>
      <matchType>0</matchType>
      <weight>1</weight>
      <confidence>10</confidence>
    </placeDetails>
    <referenceList>
      <reference>
        <woeIds>2502265</woeIds>
        <placeReferenceId>1</placeReferenceId>
        <placeIds>1</placeIds>
        <start>0</start>
        <end>12</end>
        <isPlaintextMarker>1</isPlaintextMarker>
        <text><![CDATA[Sunnyvale CA]]></text>
        <type>plaintext</type>
        <xpath></xpath>
      </reference>
    </referenceList>
  </document>
</contentlocation>

Example 2. Retrieving Places for a Given Place Name Using RSS Response

Request URI and Parameters:

Response Data:

<?xml version="1.0" encoding="utf-8"?>
<rss xmlns="http://wherein.yahooapis.com/v1/schema_rss" xmlns:georss="http://www.georss.org/georss" xmlns:cl="http://wherein.yahooapis.com/v1/cle" version="2.0" xml:lang="en">
  <channel>
    <title>Yahoo! Content Location Engine</title>
    <link><![CDATA[http://wherein.yahooapis.com]]></link>
    <description>Yahoo! Content Location Engine That Extracts Places from documents</description>
    <ttl>5</ttl>
    <pubDate>Thu, 21 Oct 2010 14:02:24 PDT</pubDate>
    <copyright>Copyright (c) 2009 Yahoo! Inc. All rights reserved.</copyright>
    <item>
      <title><![CDATA[Sunnyvale, CA, US woeId=2502265 lat=37.37161 lon=-122.03825]]></title>
      <link/>
      <description><![CDATA[Sunnyvale, CA, US woeId=2502265 lat=37.37161 lon=-122.03825]]></description>
      <cl:contentlocation>
        <cl:place>
          <cl:woeId>2502265</cl:woeId>
          <cl:name><![CDATA[Sunnyvale, CA, US]]></cl:name>
          <cl:latitude>37.3716</cl:latitude>
          <cl:longitude>-122.038</cl:longitude>
        </cl:place>
      </cl:contentlocation>
    </item>
  </channel>
</rss>

Example 3. Retrieving Places for a Given Place Name Using JSON Response

Request URI and Parameters:

Response Data:

{
    "processingTime": "0.001826", 
    "version": " build 101006", 
    "documentLength": "12", 
    "document": {
        "extents": {
            "northEast": {
                "latitude": "37.4518", 
                "longitude": "-121.979"
            }, 
            "center": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "southWest": {
                "latitude": "37.3316", 
                "longitude": "-122.081"
            }
        }, 
        "administrativeScope": {
            "woeId": "2502265", 
            "centroid": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "type": "Town", 
            "name": "Sunnyvale, CA, US"
        }, 
        "geographicScope": {
            "woeId": "2502265", 
            "centroid": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "type": "Town", 
            "name": "Sunnyvale, CA, US"
        }, 
        "localScopes": {
            "localScope": {
                "woeId": "2502265", 
                "centroid": {
                    "latitude": "37.3716", 
                    "longitude": "-122.038"
                }, 
                "type": "Town", 
                "name": "Sunnyvale, CA, US (Town)", 
                "ancestors": [
                    {
                        "ancestor": {
                            "woeId": "12587712", 
                            "type": "County", 
                            "name": "Santa Clara"
                        }
                    }, 
                    {
                        "ancestor": {
                            "woeId": "2347563", 
                            "type": "State", 
                            "name": "California"
                        }
                    }, 
                    {
                        "ancestor": {
                            "woeId": "23424977", 
                            "type": "Country", 
                            "name": "United States"
                        }
                    }
                ]
            }
        }, 
        "placeDetails": {
            "confidence": "10", 
            "weight": "1", 
            "placeReferenceIds": "1", 
            "placeId": "1", 
            "place": {
                "woeId": "2502265", 
                "centroid": {
                    "latitude": "37.3716", 
                    "longitude": "-122.038"
                }, 
                "type": "Town", 
                "name": "Sunnyvale, CA, US"
            }, 
            "matchType": "0"
        }, 
        "referenceList": {
            "reference": {
                "xpath": "", 
                "end": "12", 
                "placeIds": "1", 
                "start": "0", 
                "text": "Sunnyvale CA", 
                "placeReferenceId": "1", 
                "woeIds": "2502265", 
                "isPlaintextMarker": "1", 
                "type": "plaintext"
            }
        }
    }
}

Example 4. Retrieving Places for a Given Place Name Using JSONP Response

Request URI and Parameters:

Response Data:

myfunc(
{
    "processingTime": "0.001826", 
    "version": " build 101006", 
    "documentLength": "12", 
    "document": {
        "extents": {
            "northEast": {
                "latitude": "37.4518", 
                "longitude": "-121.979"
            }, 
            "center": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "southWest": {
                "latitude": "37.3316", 
                "longitude": "-122.081"
            }
        }, 
        "administrativeScope": {
            "woeId": "2502265", 
            "centroid": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "type": "Town", 
            "name": "Sunnyvale, CA, US"
        }, 
        "geographicScope": {
            "woeId": "2502265", 
            "centroid": {
                "latitude": "37.3716", 
                "longitude": "-122.038"
            }, 
            "type": "Town", 
            "name": "Sunnyvale, CA, US"
        }, 
        "localScopes": {
            "localScope": {
                "woeId": "2502265", 
                "centroid": {
                    "latitude": "37.3716", 
                    "longitude": "-122.038"
                }, 
                "type": "Town", 
                "name": "Sunnyvale, CA, US (Town)", 
                "ancestors": [
                    {
                        "ancestor": {
                            "woeId": "12587712", 
                            "type": "County", 
                            "name": "Santa Clara"
                        }
                    }, 
                    {
                        "ancestor": {
                            "woeId": "2347563", 
                            "type": "State", 
                            "name": "California"
                        }
                    }, 
                    {
                        "ancestor": {
                            "woeId": "23424977", 
                            "type": "Country", 
                            "name": "United States"
                        }
                    }
                ]
            }
        }, 
        "placeDetails": {
            "confidence": "10", 
            "weight": "1", 
            "placeReferenceIds": "1", 
            "placeId": "1", 
            "place": {
                "woeId": "2502265", 
                "centroid": {
                    "latitude": "37.3716", 
                    "longitude": "-122.038"
                }, 
                "type": "Town", 
                "name": "Sunnyvale, CA, US"
            }, 
            "matchType": "0"
        }, 
        "referenceList": {
            "reference": {
                "xpath": "", 
                "end": "12", 
                "placeIds": "1", 
                "start": "0", 
                "text": "Sunnyvale CA", 
                "placeReferenceId": "1", 
                "woeIds": "2502265", 
                "isPlaintextMarker": "1", 
                "type": "plaintext"
            }
        }
    }
}
);

Example 5. Setting autoDisambiguate=false

Request URI and Parameters:

Response Data:

<?xml version="1.0" encoding="utf-8"?>
<contentlocation xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" xmlns="http://wherein.yahooapis.com/v1/schema" xml:lang="en">
  <processingTime>0.035163</processingTime>
  <version> build 101006</version>
  <documentLength>12</documentLength>
  <document>
    <administrativeScope>
      <woeId>2347563</woeId>
      <type>State</type>
      <name><![CDATA[California, US]]></name>
      <centroid>
        <latitude>37.2719</latitude>
        <longitude>-119.27</longitude>
      </centroid>
    </administrativeScope>
    <geographicScope>
      <woeId>55857166</woeId>
      <type>Colloquial</type>
      <name><![CDATA[Northern California, CA, US]]></name>
      <centroid>
        <latitude>38.8979</latitude>
        <longitude>-120.028</longitude>
      </centroid>
    </geographicScope>
    <localScopes>
      <localScope>
        <woeId>55970389</woeId>
        <type>Suburb</type>
        <name><![CDATA[Sunnyvale, Placerville, CA, US (Suburb)]]></name>
        <centroid>
          <latitude>38.7321</latitude>
          <longitude>-120.726</longitude>
        </centroid>
        <ancestors>
          <ancestor>
            <woeId>2473310</woeId>
            <type>Town</type>
            <name><![CDATA[Placerville]]></name>
          </ancestor>
          <ancestor>
            <woeId>12587678</woeId>
            <type>County</type>
            <name><![CDATA[El Dorado]]></name>
          </ancestor>
          <ancestor>
            <woeId>2347563</woeId>
            <type>State</type>
            <name><![CDATA[California]]></name>
          </ancestor>
          <ancestor>
            <woeId>23424977</woeId>
            <type>Country</type>
            <name><![CDATA[United States]]></name>
          </ancestor>
        </ancestors>
      </localScope>
      <localScope>
        <woeId>2502265</woeId>
        <type>Town</type>
        <name><![CDATA[Sunnyvale, CA, US (Town)]]></name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
        <ancestors>
          <ancestor>
            <woeId>12587712</woeId>
            <type>County</type>
            <name><![CDATA[Santa Clara]]></name>
          </ancestor>
          <ancestor>
            <woeId>2347563</woeId>
            <type>State</type>
            <name><![CDATA[California]]></name>
          </ancestor>
          <ancestor>
            <woeId>23424977</woeId>
            <type>Country</type>
            <name><![CDATA[United States]]></name>
          </ancestor>
        </ancestors>
      </localScope>
    </localScopes>
    <extents>
      <center>
        <latitude>38.7321</latitude>
        <longitude>-120.726</longitude>
      </center>
      <southWest>
        <latitude>37.3316</latitude>
        <longitude>-122.081</longitude>
      </southWest>
      <northEast>
        <latitude>38.7387</latitude>
        <longitude>-120.722</longitude>
      </northEast>
    </extents>
    <placeDetails>
      <placeId>1</placeId>
      <place>
        <woeId>2502265</woeId>
        <type>Town</type>
        <name><![CDATA[Sunnyvale, CA, US]]></name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
      </place>
      <placeReferenceIds>1</placeReferenceIds>
      <matchType>0</matchType>
      <weight>1</weight>
      <confidence>10</confidence>
    </placeDetails>
    <placeDetails>
      <placeId>2</placeId>
      <place>
        <woeId>55970389</woeId>
        <type>Suburb</type>
        <name><![CDATA[Sunnyvale, Placerville, CA, US]]></name>
        <centroid>
          <latitude>38.7321</latitude>
          <longitude>-120.726</longitude>
        </centroid>
      </place>
      <placeReferenceIds>1</placeReferenceIds>
      <matchType>0</matchType>
      <weight>1</weight>
      <confidence>1</confidence>
    </placeDetails>
    <referenceList>
      <reference>
        <woeIds>2502265 55970389</woeIds>
        <placeReferenceId>1</placeReferenceId>
        <placeIds>1 2</placeIds>
        <start>0</start>
        <end>12</end>
        <isPlaintextMarker>1</isPlaintextMarker>
        <text><![CDATA[Sunnyvale CA]]></text>
        <type>plaintext</type>
        <xpath></xpath>
      </reference>
    </referenceList>
  </document>
</contentlocation>

Example 6. Retrieving Places for an RSS Feed

Request URI and Parameters:

The response data is a copy of the input document with new elements containing the content location information. Since this RSS feed is periodically updated, an example response is not available.

Yahoo! Developer Network

Table of Contents