Fire Eagle : Updating a User's Location

The one method to update a user's location is update. You can pass in a variety of location inputs to the update method. Additionally, use lookup method to make sure that you are sending in a non-ambiguous location to update.

update

Sets a user's current location using a WOEID or a set of location parameters. If the user provides a location unconfirmed with lookup method then Fire Eagle makes a best guess as to the user's location and updates.

https://fireeagle.yahooapis.com/api/0.1/update

• oauth_consumer_key : application consumer key
• oauth_token : the user-specific access token
• one or more location parameters
• oauth_nonce, oauth_timestamp, oauth_signature_method, oauth_version, oauth_signature

• label : Label for a location - like 'Home', 'Office' or 'John's house'

This method is called via HTTP POST. Returns success or failure validation response message. Success does not confirm that the user's location was updated correctly, it only acknowledges that the update request was received. Therefore, before you call the update, you should make sure that Fire Eagle properly understands how to parse the location that you're entering by using the lookup method.

Location parameter passed into Fire Eagle for updating a user's location can be from a variety of input methods. Fire Eagle will parse the location inputs in a specific order. For example, if you provide lat/lon and cell tower information, Fire Eagle will use the more precise latitude and longitude geo-coordinates and ignore the cell tower information.

• Read about location parameters
• Read about calling the API

Example: /update.xml

Request

https://fireeagle.yahooapis.com/api/0.1/update

POST Data

Response

<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok">
  <user token="mEhrJ6Zl8RHI" located-at="2008-08-06T16:04:46-08:00"/>
</rsp>

Example: /update.json

Request

https://fireeagle.yahooapis.com/api/0.1/update.json

POST Data

Response

{"user":{
  "token":"mEhrJ6Zl8RHI",
  "located_at":"2008-08-06T16:04:46-08:00"},
 "stat":"ok"}

lookup

Disambiguates potential values for update. Results from lookup can be passed to update to ensure that Fire Eagle will understand how to parse the location parameter.

https://fireeagle.yahooapis.com/api/0.1/lookup

• oauth_consumer_key : application consumer key
• oauth_token : user-specific or general-purpose access token
• one or more location parameters
• oauth_nonce, oauth_timestamp, oauth_signature_method, oauth_version, oauth_signature

Location data passed into lookup take the same location parameters as update.

Returns a list of values that match the location parameters suitable for passing to update. If a lat/lon pair is provided, it will be returned directly, as it is not ambiguous. A street address that maps exactly will return the street address; any associated Place ID returned will be less precise. A less precise address will return 1 or more Place IDs with accompanying human readable names.

Use this method to ask Fire Eagle to disambiguate location names your users have entered: e.g. user enters Pensacola, use lookup to see that Pensacola could be Pensacola, FL or Pensacola, NC or Pensacola, OK.

• Read about location parameters
• Read about calling the API

Example: /lookup.xml

Request

Response

<rsp stat="ok">
  <query>address=Pensacola</query>
  <locations start="0" total="3" count="3">
    <location>
      <name>Pensacola, FL</name>
      <place-id>qQ7Vig2bBZsZCy82</place-id>
      <woeid>2470377</woeid>
    </location>
    <location>
      <name>Pensacola, NC</name>
      <place-id>4.CTkJibBZv.G1c2</place-id>
      <woeid>2470405</woeid>
    </location>
    <location>
      <name>Pensacola, OK</name>
      <place-id>bRDKoQibBZtXopXZ</place-id>
      <woeid>2470375</woeid>
    </location>
  </locations>
</rsp>

Example: /lookup.json

Request

Response

{"start":0,
 "stat":"ok",
 "locations":[{"name":"Pensacola, FL",
               "place_id":"qQ7Vig2bBZsZCy82",
               "woeid":2470377},
              {"name":"Pensacola, NC",
               "place_id":"4.CTkJibBZv.G1c2",
               "woeid":2470405},
              {"name":"Pensacola, OK",
               "place_id":"bRDKoQibBZtXopXZ",
               "woeid":2470375}],
 "count":3,
 "total":3,
 "query":"address=Pensacola"}