Yahoo! Boss Geo

Prev — Error Codes

Chapter 6. Free Non-Commercial YQL Table Usage — Next

Examples

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

XML is the default response format. This example shows the XML response for the following parameters: documentContent=Sunnyvale+CA anddocumentType=text/plain.

Request URI and Parameters:

http://yboss.yahooapis.com/geo/placespotter?documentContent=Sunnyvale+CA&documentType=text/plain

Response Data:

<bossresponse responsecode="200">
  <placespotter>
    <document>
      <administrativescope>
        <woeid>2502265</woeid>
        <type>Town</type>
        <name>Sunnyvale, CA, US</name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
      </administrativescope>
      <geographicscope>
        <woeid>2502265</woeid>
        <type>Town</type>
        <name>Sunnyvale, CA, US</name>
        <centroid>
          <latitude>37.3716</latitude>
          <longitude>-122.038</longitude>
        </centroid>
      </geographicscope>
      <localscopes>
        <localscope>
          <woeid>2502265</woeid>
          <type>Town</type>
          <name>Sunnyvale, CA, US (Town)</name>
          <centroid>
            <latitude>37.3716</latitude>
            <longitude>-122.038</longitude>
          </centroid>
          <southwest>
            <latitude>37.3316</latitude>
            <longitude>-122.081</longitude>
          </southwest>
          <northeast>
            <latitude>37.4518</latitude>
            <longitude>-121.979</longitude>
          </northeast>
          <ancestors>
            <ancestor>
              <woeid>12587712</woeid>
              <type>County</type>
              <name>Santa Clara</name>
            </ancestor>
            <ancestor>
              <woeid>2347563</woeid>
              <type>State</type>
              <name>California</name>
            </ancestor>
            <ancestor>
              <woeid>23424977</woeid>
              <type>Country</type>
              <name>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>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>13</end>
          <isplaintextmarker>1</isplaintextmarker>
          <text>Sunnyvale,+CA</text>
          <type>plaintext</type>
          <xpath/>
        </reference>
      </referencelist>
    </document>
  </placespotter>
</bossresponse>

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

This example shows the JSON response for the following parameters: documentContent=Sunnyvale+CA, &outputType=json, and &documentType=text/plain.

Request URI and Parameters:

http://yboss.yahooapis.com/geo/placespotter?documentContent=Sunnyvale+CA&outputType=json&documentType=text/plain

Response Data:

({
  "bossresponse": {
    "responsecode": "200",
    "placespotter": [{
      "administrativescope": {
        "woeid": "2502265",
        "type": "Town",
        "name": "Sunnyvale, CA, US",
        "centroid": {
          "latitude": "37.3716",
          "longitude": "-122.038"
        }
      },
      "geographicscope": {
        "woeid": "2502265",
        "type": "Town",
        "name": "Sunnyvale, CA, US",
        "centroid": {
          "latitude": "37.3716",
          "longitude": "-122.038"
        }
      },
      "localscopes": [{
        "woeid": "2502265",
        "type": "Town",
        "name": "Sunnyvale, CA, US (Town)",
        "centroid": {
          "latitude": "37.3716",
          "longitude": "-122.038"
        },
        "southwest": {
          "latitude": "37.3316",
          "longitude": "-122.081"
        },
        "northeast": {
          "latitude": "37.4518",
          "longitude": "-121.979"
        },
        "ancestors": [{
          "woeid": "12587712",
          "type": "County",
          "name": "Santa Clara"
        },
        {
          "woeid": "2347563",
          "type": "State",
          "name": "California"
        },
        {
          "woeid": "23424977",
          "type": "Country",
          "name": "United States"
        }]
      }],
      "extents": {
        "center": {
          "latitude": "37.3716",
          "longitude": "-122.038"
        },
        "southwest": {
          "latitude": "37.3316",
          "longitude": "-122.081"
        },
        "northeast": {
          "latitude": "37.4518",
          "longitude": "-121.979"
        }
      },
      "placedetails": {
        "placeid": "1",
        "place": {
          "woeid": "2502265",
          "type": "Town",
          "name": "Sunnyvale, CA, US",
          "centroid": {
            "latitude": "37.3716",
            "longitude": "-122.038"
          }
        },
        "placereferenceids": "1",
        "matchtype": "0",
        "weight": "1",
        "confidence": "10"
      },
      "referencelist": [{
        "woeids": "2502265",
        "placereferenceid": "1",
        "placeids": "1",
        "start": "0",
        "end": "13",
        "isplaintextmarker": "1",
        "text": "Sunnyvale,+CA",
        "type": "plaintext"
      }]
    }]
  }
})

Example 5.3. Setting autoDisambiguate=false

Request URI and Parameters:

http://yboss.yahooapis.com/geo/placespotter?documentContent=Sunnyvale+US&documentType=text/plain&autoDisambiguate=false&outputType=xml

Response Data:

<bossresponse responsecode="200">
  <placespotter>
    <document>
      <administrativescope>
        <woeid>2347563</woeid>
        <type>State</type>
        <name>California, US</name>
        <centroid>
          <latitude>37.2719</latitude>
          <longitude>-119.27</longitude>
        </centroid>
      </administrativescope>
      <geographicscope>
        <woeid>55857166</woeid>
        <type>Colloquial</type>
        <name>Northern California, CA, US</name>
        <centroid>
          <latitude>38.8979</latitude>
          <longitude>-120.028</longitude>
        </centroid>
      </geographicscope>
      <localscopes>
        <localscope>
          <woeid>2502265</woeid>
          <type>Town</type>
          <name>Sunnyvale, CA, US (Town)</name>
          <centroid>
            <latitude>37.3716</latitude>
            <longitude>-122.038</longitude>
          </centroid>
          <southwest>
            <latitude>37.3316</latitude>
            <longitude>-122.081</longitude>
          </southwest>
          <northeast>
            <latitude>37.4518</latitude>
            <longitude>-121.979</longitude>
          </northeast>
          <ancestors>
            <ancestor>
              <woeid>12587712</woeid>
              <type>County</type>
              <name>Santa Clara</name>
            </ancestor>
            <ancestor>
              <woeid>2347563</woeid>
              <type>State</type>
              <name>California</name>
            </ancestor>
            <ancestor>
              <woeid>23424977</woeid>
              <type>Country</type>
              <name>United States</name>
            </ancestor>
          </ancestors>
        </localscope>
        <localscope>
          <woeid>55970389</woeid>
          <type>Suburb</type>
          <name>Sunnyvale, Placerville, CA, US (Suburb)</name>
          <centroid>
            <latitude>38.7321</latitude>
            <longitude>-120.726</longitude>
          </centroid>
          <southwest>
            <latitude>38.7302</latitude>
            <longitude>-120.727</longitude>
          </southwest>
          <northeast>
            <latitude>38.7387</latitude>
            <longitude>-120.722</longitude>
          </northeast>
          <ancestors>
            <ancestor>
              <woeid>2473310</woeid>
              <type>Town</type>
              <name>Placerville</name>
            </ancestor>
            <ancestor>
              <woeid>12587678</woeid>
              <type>County</type>
              <name>El Dorado</name>
            </ancestor>
            <ancestor>
              <woeid>2347563</woeid>
              <type>State</type>
              <name>California</name>
            </ancestor>
            <ancestor>
              <woeid>23424977</woeid>
              <type>Country</type>
              <name>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>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>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>13</end>
          <isplaintextmarker>1</isplaintextmarker>
          <text>Sunnyvale, CA</text>
          <type>plaintext</type>
          <xpath/>
        </reference>
      </referencelist>
    </document>
  </placespotter>
</bossresponse>

Prev — Error Codes

Chapter 6. Free Non-Commercial YQL Table Usage — Next

Yahoo! Developer Network

Yahoo! Boss Geo

Examples

Table of Contents