Fire Eagle : Status and Error Codes

Status and Error Codes

HTTP Status Codes

Your first clue that something has gone wrong with an OAuth or Location API request to Fire Eagle will be the HTTP Status code.

Any status other than 200 OK means something went awry.

The error status codes you're likely to see are:

  • 400 Bad Request - You omitted a required parameter or Fire Eagle couldn't make sense of a parameter you supplied. Maybe it was a unrecognized user token or perhaps a location Fire Eagle couldn't make sense of.
  • 401 Unauthorized - This is probably caused by a problem with the OAuth parameters attached to your request. The OAuth signature may be wrong or one of the tokens is in a bad state (e.g. you used a request token instead of an access token).
  • 403 Forbidden - Your user hasn't granted your application permission to complete the requested operation (or maybe the user's Fire Eagle account has been temporarily suspended).
  • 404 Not Found - You're using the wrong URL. Double-check it.
  • 405 Method Not Allowed - You used a POST when Fire Eagle was expecting a GET or vice-versa. Use POST to update a user's location, GET should work for most everything else (including the OAuth authorization).
  • 500 Internal Server Error - Some bit of Fire Eagle's system has become badly confused. Please let us know if this error persists.

Error Response Format

When you get an error response (other than a 404 or 500), the body of the response should look something like the following:

XML Error Format

<?xml version="1.0" encoding="utf-8" ?> <rsp stat="fail">
<err msg="[error message]" code="[error code]" />
</rsp>

JSON Error Format

{"rsp":{"message":"[error message]",
"stat":"fail",
"code":[error code]}}

NOTE: If a JSON callback was specified with the callback parameter, the error will also be wrapped.


Error Codes and Messages

CodeMessage
1Update not permitted for that user.
The user has chosen not to let your application update their location. Urge them to change the permissions for your app at the My Applications page.
3Query not permitted for that user.
The user has chosen not to let your application query their location. Urge them to change the permissions for your app at the My Applications page.
4User account is suspended.
The user must come to the Fire Eagle site to reactivate their account. Tell them to do it.
6Place can't be identified.
Fire Eagle couldn't resolve the location you provided. Try another location.
7Authentication token can't be matched to a user.
Fire Eagle doesn't know who you're trying to update or query for. You might need that user to re-authorize your application.
8Invalid location query.
You didn't provide all the required location parameters for a location-parameter query (such as: update, location, or within).
10Token provided is a request token, not an access token.
You need to exchange your request token for an access token (read more about the User Authorization process).
11Request token has not been validated.
You tried to exchange your request token before a user authorized it (read more about the User Authorization process).
12Token provided must be an access token.
You need to use an access token, not a request token, not a general purpose token.
13Token has expired.
Request tokens must be exchanges within 1 hour of requesting them.
14Token provided must be a general purpose token.
A user access token is no good here. Use a general purpose token for within and recent queries.
15Unknown consumer key.
Did you copy your consumer key properly from the Manage Applications page?
16Token not found.
Maybe the token has been deleted (a user unsubscribed from your app) or maybe it was copied wrong or corrupted.
20oauth_consumer_key parameter required.
You're missing a required parameter.
21oauth_token parameter required.
You're missing a required parameter.
22Unsupported signature method.
Fire Eagle doesn't support the OAuth signature method you tried. We recommend HMAC-SHA1.
23Invalid OAuth signature.
The oauth_signature parameter is invalid. Check your parameter encoding and make sure you order parameters alphabetically when generating signature base string.
24Provided nonce has been seen before.
To prevent replay attacks Fire Eagle requires that you supply a different oauth_nonce/oauth_timestamp pair for each API request.
30Use fireeagle.yahooapis.com for api methods.
To prevent cross site scripting attacks and allow for flash clients to use Fire Eagle we require that all requests to the api's are done at fireeagle.yahooapis.com
31SSL required, this method must be requested with https
For added security this method may only be requested via ssl (https) and can not be accessed with http.
32Rate limit/IP Block due to excessive requests.
To prevent denial of service attacks, Fire Eagle will block an application for an hour if excessive requests are detected (more than six per minute, sustained over an hour). Please make sure your code throttles excessive requests.
33Invalid OAuth verifier.
The oauth_verifier parameter presented to get the user's access token is invalid.
34OAuth callback required.
The request must specify a oauth_callback parameter.
35Invalid callback URL.
The value of the oauth_callback is an invalid URL.
36Timestamp expired.
Timestamp older than one hour.
37Invalid HTTP method.
Please check the developer documentation for the allowed methods for a specific API.
38Invalid OAuth version.
Currently supported OAuth version is 1.0 only.
39Time argument out of range.
Timestamp is not in a parsable format or is in the future.