Public API – Error Codes

The following are the error codes used by the API.

Error codes

errorCode Title Description
2000 Request Not Supported This error is returned if the request URL is incorrect or the request type sent as part of the header is incorrect.
2002 Format Error This error is returned if the datatype of the field is incorrect, the field is left blank or the field is not in the required format.
2003 Package Name Format Error This error is returned if the format of the packageName field in the Create Application field is incorrect. Package name should should contain a minimum of 3 periods and will generally consist of related domain name in reverse and the name of the app (e.g. com.bluedot.appname).
2004 Time Field Format Error This error is returned if the datatype of a time related fields are incorrect or the field is not provided in the required format which is HH:MM
2005 Date Field Format Error This error is returned if the datatype of date-related fields are incorrect or the field is not provided in the required format which is DD/MM/YYYY
2006 Missing Field This error is returned if a required field is missing in the request.
2007 Geometry Error This error is returned if Geofence submitted in the request has errors.
2008 Beacon Configuration Details Error The error is returned if the beacon request has errors in the beacon configuration fields.
2009 Object Missing Errors Please provide one of the following shapes, actions or conditions.
2010 Array Errors This error is returned if the array objects in the request do not have at least one object in them.
2011 Number Error This error is returned if the fields which are of datatype number have incorrect values.
2013 Maximum Custom Data Items Array customFields must have no more than 5 items.
2014 Duplicate Custom Data Key Duplicate key detected in Custom Data Fields.
2015 Sequence Length Mismatch This error is returned when the sequence provided for the sequence condition has a different number of Geofeature IDs than what is in the Zone.
2016 Geofeature Not Found This error is returned when the Geofeature ID provided does not exist in the Zone.
2017 Date Range Order This error is returned when the end date field is provided before the start date field.
2018 Minimum Difference in  Speed Condition When the difference between the minimum and maximum speed is less than 5, this error is returned.
2019 Minimum Difference in  Bearing Condition When the angle difference between the From Angle and To Angle is less than 90, this error is returned.
2020 Geofeature Repeated When the Geofeature in sequence more than once in the zones/sequence Post request this error is returned.
2021 Keyword Or Type Required When the fields `keyword`, `type` or both are not included in the Bluedot Places Lookup request, this error is returned.
2022 No Matching Bluedot Places Location found When no known match for the location is provided in the Bluedot Places Lookup request, this error is returned.
2023 Speed and Bearing Condition added for Beacons This error is reported when Speed and bearing condition are added to zones containing beacons.
2024 Lookup ID not Found When the Lookup Id provided in the Bluedot Places requests is not found in the database this error is returned.
2025 Executing an executed lookup When a Lookup has already been executed and it is re-executed this error is returned.
2026 More than one Percentage Crossed condition  This error is returned when more than one Percentage Crossed condition is added to a single zone.
2027 Mismatch in API key in Lookup When the wrong API key supplied for lookup requests, this error is returned.
2028 Very Large Goefences added to Zones with Speed and Bearing This error is reported when very large Geofences are added to Zones containing Actions with Speed and Bearing Conditions.
2029 Beacons added to Zones with Speed and Bearing This error is reported when Beacons are added to Zones containing Actions with Speed and Bearing Conditions.
2030 Incorrect Place ID Supplied When a Place ID is provided in the Create Zone Bluedot Places requests  does not appear in result list then this error is returned.
2031 Insufficient Poi Credits This error is returned when the user does not have sufficient POI credits to execute Bluedot Places requests.
2032 Invalid Places Type This error is returned when Type supplied in the Bluedot Places request is from the standard expected list.
2033 Invalid Page Number When a page number supplied is not available for the lookup then this error is returned.
2034 No Bluedot Places Results Found When the lookup returns 0 results this error is returned.
2035 Bluedot Places Area Too Large This error is returned when the Bluedot Places search area provided is larger than 1000km.
2036 Invalid Bluedot Places Area Type This error is returned when the Bluedot Places Area type provided is not ‘circle’.
2038 Fence Type Error in Bluedot Places Create Zone  Please provide one of the following fence types – rectangle or circle.
2222 Generic Error This is a generic error code returned for generic errors.
3001 Customer Not Found This error will be returned if a customer with the provided Customer API key cannot be found.
3002 Api Keys Mismatch This error will be returned if the Application API key provided cannot be found for the Customer API key provided.
3003 Id Not Found This error is returned if the identifiers provided in the request cannot be found in the database.
3004 Duplicate Values This error is returned if the request contains objects which already exist in the database.
4001 Invalid Properties This error is returned if the request contains additional fields than what the server expects.
4002 Invalid JSON Structure This error is returned if the request contains incorrectly formed JSON.
6000 Generic Error Type Following errors are reported under this error code.

  • Null Application Id: Application ID is not provided in the request.
  • No Html Only: Parameters may not only contain HTML.
  • Parameter Cannot Be Null: The parameter in the GET or DELETE request is NULL.
  • Parameter Wrong Type: The data type of the parameter in the GET or DELETE request is wrong.
  • Parameter Must Be Positive: The data type of the parameter in the GET or DELETE request is a negative number (mostly for page numbers).
  • Parameter Too Large: The value of the parameter in the GET or DELETE request is too large.
  • Unauthorized Request: An unauthorized method used to request the endpoint.
  • Forbidden Request: An forbidden endpoint being requested.
  • Forbidden Beacon Being Used: A beacon added to a Zone is being deleted.
  • Internal Server Error: The request could not be completed due to an error.
  • Generic Validation Error
  • Invalid Parameter Combo: Invalid combination of parameters provided in the GET and DELETE request.
Created by Bluedot DevOps on March 5, 2018

Start the discussion