API errors

Error results

When something goes wrong with an API call, an error is returned. Here are the values returned:

• Parameter name

  Parameter value

• code

  ERROR

• message

  Description of the error in english

• errorCode

  (Optional) Code identifying the error.

• errorMessage

  (Optional) Translation of the error message in the language of the user

Here is an example of an error result:

			{"ApiReturn":
				{"code":"ERROR",
				"message":"Invalid account access, apikey is empty",
				"errorCode":"3001",
				"errorMessage":"Erreur d'accès au compte, l'apikey est vide"}
			}
			

Error codes

Here is a list of the usual error codes you can get while using the API.

• Error code

  Description

• -1

  "Unknown Error". Not a error listed here.

• 101

  "Concurrent modifications". The data has been changed by another process, and your data are now obsolete.

• 3000

  "No criteria given". For example your are trying to get a FidelityMember without giving an id, email or any other criteria.

• 3001

  "Invalid APIKEY: null or empty". You need to give an APIKEY for every API call

• 3002

  "Invalid user access (APIKEY, login or password are incorrect: no admin user found)"

• 3003

  "Invalid account access (APIKEY and/or idExternal are incorrect: no account found)"

• 3004

  "Invalid account access, more than one account find with APIKEY and/or idExternal"

• 3005

  "Unable to connect with the given APIKEY"

• 3006

  "WebApi call: MAX_OUTPUT_SIZE exceeded". The request you made has too much data to return. Please be more specific.

• 3007

  "Nothing to search, no object definition found: your request was empty."

• 3008

  "No object found"

• 3009

  "Unsupported action"

• 3010

  "Forbidden field/object modification or creation"

• 3011

  "Wrong value format"

• 3012

  "Wrong number format"

• 3013

  "String content of the HTTP's body is malformed"

• 3014

  "The object references a non-unique subobject": Please make sure your criteria is enough

• 3015

  "Syntax of the HTTP's body is malformed"

• 3016

  "No object saved"

• 3017

  "Not supported yet"

• 3018

  "Request too long, timeout"

• 3019

  "Missing mandatory parameter"

• 3020

  "Content-type not supported"

• 3021

  "Wrong HTTP method for this action"

• 3022

  "Code already used"

• 3023

  "Too many actions requested"

• 3024

  "Too many calls on API V2 from this IP address"

• 3101

  "Concurrent modification detected, we will automatically retry later 3 times"