Utrecht University · Schema

Yoda API Result

Standard response envelope returned by every Yoda Core and Datarequest API operation. The Yoda HTTP API (https://utrechtuniversity.github.io/yoda-ruleset/) wraps all responses in this object.

EducationHigher EducationUniversityNetherlandsResearch DataOpen AccessLibraryOpen Source

Properties

Name Type Description
status string Status identifier. 'ok' on success, or an error ID on failure.
status_info stringnull Human-readable status or error description.
data objectarraystringnumberbooleannull Operation-specific payload. May be an object, array, scalar, or null.
View JSON Schema on GitHub

JSON Schema

utrecht-yoda-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/utrecht/main/json-schema/utrecht-yoda-result-schema.json",
  "title": "Yoda API Result",
  "description": "Standard response envelope returned by every Yoda Core and Datarequest API operation. The Yoda HTTP API (https://utrechtuniversity.github.io/yoda-ruleset/) wraps all responses in this object.",
  "type": "object",
  "required": ["status", "status_info", "data"],
  "properties": {
    "status": {
      "type": "string",
      "description": "Status identifier. 'ok' on success, or an error ID on failure."
    },
    "status_info": {
      "type": ["string", "null"],
      "description": "Human-readable status or error description."
    },
    "data": {
      "description": "Operation-specific payload. May be an object, array, scalar, or null.",
      "type": ["object", "array", "string", "number", "boolean", "null"]
    }
  }
}