Gandi Wiki


Questions

Important:

¡Ayúdanos con el español!

Esta página todavía no ha sido traducida (o sólo parcialmente) en español. Si hablas francés o inglés, puedes ayudarnos.
Aquí encontrarás la versión FR de esta página, que podrás editar sólo con identificarte (con tu usuario Gandi).

Si prefieres traducir a partir de la versión EN, sólo tienes que abrir una nueva ventana, copiar-pegar la URL de la página y hacer clic en la bandera (arriba a la derecha) del idioma correspondiente. Si la página existe, aparecerá en el idioma deseado.

Gracias de antemano por ayudarnos con el español :)

Error codes format

Description

XML-RPC errors are contained in > faults < that have a value (faultCode) encoded as an integer and a message (faultString). The Gandi XML-RPC interface error codes are normalized. The format of Gandi errors is hierarchical and built upon the scheme:

qualification (one digit) object (three digits) cause (two digits)

Qualification

The qualification, encoded on one digit, helps distinguishing between an input error and something that went wrong on the server side. There are two qualifications:

  • Server: internal errors during the processing of a request
  • Data: data error, wrong or malformed input

Object

The object, encoded on three digits, depends on the qualification. For a Server qualification it may be Network, Database, System etc. For a Data qualification it is related to the objects passed as arguments, for instance a Phone Number.

Cause

The cause, encoded on two digits, depends on the object. For a Database object it may be a failed query and for a Phone Number it may be a Syntax Error.

Qualification 1 - Server

Objects and causes

100. Database

Causes:

  • 10. connection lost
  • 20. query failed
  • 40. could not find object
  • 42. returned too many rows
500. Application

Causes:

  • 00. internal error, logged and reported

Message

The message associated to an error code is formatted as follow: <span class="format|ServerError: plain text description of the problem</span>

Sample error codes

faultCode faultString
110020 ServerError: database query failed
110040 ServerError: database could not find object
150000 ServerError: internal error (error has been logged and will be reported

Qualification 2 - Data

In this qualification, all the objects share the same causes.

Objects

  • 001. Password
  • 002. Session
  • 010. Integer
  • 011. Boolean
  • 012. String
  • 013. Date
  • 014. List
  • 015. Struct
  • 016. Method
  • 050. E-mail address
  • 051. URL
  • 052. FQDN
  • 053. IPv4 address
  • 054. Web redirection
  • 100. Domain
  • 101. Account
  • 102. Operation id
  • 140. Company Name
  • 141. Public Body Name
  • 142. Association Name
  • 150. Phone parameter
  • 151. French department
  • 152. Country code
  • 153. Contact type
  • 154. Contact class
  • 155. ISO 639-2 Alpha-3 language code
  • 156. Contact preferred language
  • 200. Redirection type
  • 201. Buy/Renew period
  • 250. Operation state
  • 251. Operation type
  • 252. Operation event

Causes

Checks on data are done sequentially. Depending on the type, not all checks apply. However, a data validation cycle is the following: first the type is checked, then the syntax and the value, then the existence of the object, then the privileges and, finally, the state.

  • 00. Unknown: the cause of the error is unknown
  • 10. Type: the data is of a wrong type (eg: an int instead of a string)
  • 20. Syntax: the syntax used is incorrect (eg: .";-GANDI for a login)
  • 30. Value: incorrect value for the object (eg: an operation ID below 0)
  • 31. Size: the object has an invalid size
  • 32. Expected: the object is not present and it is supposed to be (eg: a missing company_name for a company contact creation)
  • 33. Unexpected: the object is present but it is not supposed to be (eg: a company_name for an individual contact creation)
  • 34. Identical: multiple identical values in list were found.
  • 40. DontExist: this object does not exist (eg: a wrong account)
  • 41. Exist: the data already exist (eg: request of creation of an existing domain)
  • 50. Rights: the logged user does not have enough privilege on the object
  • 60. State: the object is in a state where the requested operation is impossible

Message

The message associated to an error code is a plain text representations of the problem. It is formated as follow: DataError: plain text description of the problem [element: value]

Element is the name of the faulty parameter with its value appended after a colon and a space.

Sample error codes

faultCode faultString
500130 DataError: invalid value for password [password: 123456]
510210 DataError: invalid type for operation id [opid: test]
510050 DataError: not enough privileges to access domain [domain: gandi.net]

Questions

No question on this page and its children.

RSS feed for questions matching this filter (Help)

Última modificación: Europe/BerlinTuesday 27/04/2010 a Tuesdaypm06 12:16 (editor externo)