Esta página es parte de la documentación de la API de acciones de MediaWiki.

Si algo sale mal en uan solicitud a la API, un error o advertencia aparecerá (aunque la respuesta HTTP usualmente seguirá siendo 200 OK). Las advertencias aparecen con condiciones no fatales, como parámetros no válidos, mientras que los errores solo aparecen con condiciones fatales.

Advertencia

Las advertencias se agrupan por el nombre del módulo que las causa. Múltiples advertencias del mismo módulo están separadas por una nueva línea. En el modo de formato de error heredado (ver a continuación), que es el predeterminado, las advertencias se emiten en el siguiente formato:

"warnings": {
    "modulename": {
      "*": "warning text"
    }
  }

(* será reemplazado por warnings cuando se use formatversion=2.)

Cuando se utiliza una opción de formato de error no heredada, las advertencias se generan en el mismo formato que los errores. Por ejemplo con errorformat=wikitext el formato será:

"warnings": [
    {
        "code": "warning message key",
        "*": "text of warning",
        "module": "API module which caused the warning"
    }
]

(* will be replaced with text when formatversion=2 is used.)

Since MediaWiki 1.29 errors are localizable, and available in multiple formats. An error (or warning) is expected to consist of a message, an error code (an arbitrary string, usually generated from the message key; see also #Standard error messages below), and optional extra data (an associative array). An API response with errors will look like this:

{
    "errors": [
        {
            "code": "error-code",
            /* ...error message..., */
            "data": [ /* ...any extra data... */ ],
            "module": "path to the API module that generated the error"
        },
        /* ...more errors... */
    ],
    "docref": "human-readable message on where to find help"
}

The data key in the output above will be missing if there is no extra data to display.

The way the error message in the output above is returned to the client is controlled by the errorformat API parameter. The various error formats available are:

    "html": "the message, interpreted as wikitext and parsed into HTML"

    "text": "the message as-is, with parameter substitution but without any parsing"

    "text": "the message, like wikitext, but with added plaintext conversion"

    "key": "message key",
    "params": [ /* ...message parameters... */ ]

For the formatting modes which involve message lookup (html, wikitext and plaintext) the API parameter errorlang can be used to set the language (only needed when different from the content language) and errorsuselocal to set whether the MediaWiki: namespace can be used to override default error messages.

Error codes are also returned in the MediaWiki-API-Error response HTTP header, separated by commas when there are multiple errors.

For an example error response or to test your client's error handling, visit https://en.wikipedia.org/w/api.php?action=blah&errorformat=plaintext&format=jsonfm&formatversion=2

API responses can contain multiple errors. For an example, try adding the lines the abusefilter will block this and the abusefilter will also block this to a Test Wikipedia page as API sandbox (if you are logged in, go to the action=edit tab and click Rellenar la ficha automáticamente first before making the request).

In the legacy error format, there is always at most one error; additional ones are discarded. The response looks like this:

{
    "error": {
        "code": "error-code",
        "info": "the message as-is, with parameter substitution but without any parsing",
        /* ...any extra data... */
    }
}

The extra data in the output above is spliced into the object instead of being under the data key.

Error messages are documented in this wiki as shown below, which corresponds to the json error response in #Legacy format above:

The various error messages are:

Notas adicionales

• Todas las salidas de errores y advertencias anteriores usan format=json&formatversion=2. Para formatversion=1, el campo docref será reemplazado por *.

• Maintained by MediaWiki Interfaces Team.
• Live chat (IRC): #mediawiki-core ^connect
• Issue tracker: Phabricator MediaWiki-Action-API (Report an issue)