Responseformat

HTTP-Antwort

Header Wert
Content-Type application/json; charset=utf-8
Access-Control-Allow-Origin *
X-Total-Count (Gesamtzahl der Treffer bei großen Antwortmengen, falls bekannt)
Content-language (Bei Autovervollständigung)


HTTP-Status-Codes

Code Was
200 - Ok Die Anfrage war erfolgreich und wurde beantwortet.
400 - Bad Request Fehler in der Anfragesyntax oder bei der Authentifizierung (ingest)
404 - Not Found DANTE nicht erreichbar, kann nicht gelesen werden
422 - Unprocessable Content Z.B. Ingest-JSKOS nicht valide
429 - Too Many Requests z.B. konfigurierte Ingest-Limits überschritten


Error

Fehlerantworten werden als JSON mit den Feldern ErrorCode, ErrorMessage und Description zurückgegeben. Die folgenden Beispiele entsprechen Meldungen aus dem API-Code; die konkreten Details hängen vom Fehlerfall ab.

400 – Bad Request

Ungültiger JSON-Request-Body beim Ingest
          
{
  "ErrorCode": "400",
  "ErrorMessage": "Bad Request",
  "Description": "Requestbody nicht valide."
}
Ungültiger Ingest-Token
          
{
  "ErrorCode": "400",
  "ErrorMessage": "Bad Request",
  "Description": "Ingest-Token nicht valide."
}

422 – Unprocessable Content

Im JSKOS-Datensatz fehlt inScheme
          
{
  "ErrorCode": "422",
  "ErrorMessage": "Unprocessable Entity",
  "Description": "JSKOS nicht valide: 'inScheme' nicht vorhanden'"
}
Das deutsche prefLabel fehlt
          
{
  "ErrorCode": "422",
  "ErrorMessage": "Unprocessable Entity",
  "Description": "JSKOS nicht valide: 'prefLabel' in Sprache 'de' nicht vorhanden'"
}

429 – Too Many Requests

Das konfigurierte Minutenlimit für Ingest-Aufrufe wurde erreicht
          
{
  "ErrorCode": "429",
  "ErrorMessage": "Too Many Requests",
  "Description": "Minutenlimit von <konfiguriertes Limit> Aufrufen erreicht."
}