Utrecht University · JSON Structure

Utrecht Yoda Error Structure

JSON Structure for the Yoda API error envelope (result_error) returned on HTTP 400 and 500 responses.

Type: object Properties: 3 Required: 2
EducationHigher EducationUniversityNetherlandsResearch DataOpen AccessLibraryOpen Source

YodaErrorResult is a JSON Structure definition published by Utrecht University, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0 meta-schema.

Properties

status status_info data

Meta-schema: https://json-structure.org/meta/core/v0

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0",
  "$id": "https://raw.githubusercontent.com/api-evangelist/utrecht/main/json-structure/utrecht-yoda-error-structure.json",
  "name": "YodaErrorResult",
  "description": "JSON Structure for the Yoda API error envelope (result_error) returned on HTTP 400 and 500 responses.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Holds an error ID."
    },
    "status_info": {
      "type": "string",
      "description": "Holds a human-readable error description."
    },
    "data": {
      "type": ["object", "null"],
      "description": "Empty on error."
    }
  },
  "required": ["status", "status_info"]
}