API Error Messages

This page is used to track any error messages returned by the REST API or WebSocket, as well as what triggered them.

This only affects the low-level interface via auraxium.census, the associated errors should not leave the internal modules.

Note: Keep in mind that errors raised for joins are silent and will only prevent the associated join from being displayed. There is no error message or other indication that something went wrong.

If you come across any other error messages, please open an issue so it can be added to the list.

Server Errors

• Providing an empty URL, e.g. https://census.daybreakgames.com/get/:

  {
    "errorCode": "SERVER_ERROR"
  }

Invalid Search Term

• Using non-integer values for integer fields:

  {
    "errorCode": "SERVER_ERROR",
    "errorMessage": "INVALID_SEARCH_TERM: Invalid search term: c:limit. Value must be a whole number."
  }

• Using invalid field names for top-level queries:

  {
    "errorCode": "SERVER_ERROR",
    "errorMessage": "INVALID_SEARCH_TERM: Invalid search term. Valid search terms: [...]"
  }

• Too few characters provided in queries using regular expressions (i.e. ones prefixed with ^ or *):

  {
    "errorCode": "SERVER_ERROR",
    "errorMessage": "INVALID_SEARCH_TERM: Invalid search value for term: name.first. Regex query must have at least 3 characters."
  }

• Raised when using invalid field names for c:show or c:hide:

  {
    "errorCode": "SERVER_ERROR",
    "errorMessage": "INVALID_SEARCH_TERM: c:show or c:hide resulted in no valid terms."
  }

API Maintenance

• Any form or redirection to missing APIs is a sign of the API undergoing maintenance. Examples:

  • http://www.station.sony.com/services/en/sorry.htm
  • http://maintenance.station.sony.com

  Update 16 Sept. 2020: These outdated links have been replaced with http://www.daybreakgames.com/. Any 302s now redirect here, and it is also no longer a sure sign of API maintenance. This page will be updated as I figure out the details.

Service IDs

• Invalid or unknown service ID:

  {
    "error": "Provided Service ID is not registered.  A valid Service ID is required for continued api use. (http://census.daybreakgames.com/#devSignup)"
  }

• Missing service ID/rate limited:

  {
    "error": "Missing Service ID.  A valid Service ID is required for continued api use.  The Service ID s:example is for casual use only.  (http://census.daybreakgames.com/#devSignup)"
  }