Diese Seite ist Teil der Dokumentation der MediaWiki action API.

Wenn bei einer API-Abfrage etwas schief geht, wird ein Fehler oder eine Warnung ausgegeben (obwohl die HTTP-Antwort normalerweise trotzdem 200 OK ist). Bei nicht schwerwiegenden Bedingungen wie ungültigen Parametern werden Warnungen ausgegeben, während Fehler nur bei schwerwiegenden Bedingungen ausgegeben werden.

Warnungen

Warnungen werden nach dem Namen des Moduls gruppiert, das sie verursacht hat. Mehrere Warnungen desselben Moduls werden durch eine neue Zeile getrennt. Im Legacy-Modus der Fehlerformatierung (siehe unten), welcher der Standard ist, werden Warnungen im folgenden Format ausgegeben:

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

(* wird durch warnings ersetzt, wenn formatversion=2 genutzt wird.)

Wenn eine Nicht-Legacy-Option zur Fehlerformatierung genutzt wird, werden Warnungen im selben Format ausgegeben wie Fehler. Mit errorformat=wikitext ist das Format beispielsweise:

"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 Den Token automatisch ausfüllen 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:

Zusätzliche Anmerkungen

• Alle oben genannten Ausgaben von Fehlern und Warnungen nutzen format=json&formatversion=2. Für formatversion=1 wird das Feld docref durch * ersetzt.

• Gewartet von MediaWiki Interfaces Team.
• Echtzeit-Chat (IRC): #mediawiki-core ^connect
• Problem-Tracker: Phabricator MediaWiki-Action-API (Problem melden)