Utrecht University · JSON Structure

Utrecht Yoda Result Structure

JSON Structure for the standard Yoda API response envelope used by all Core and Datarequest operations.

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

YodaResult is a JSON Structure definition published by Utrecht University, describing 3 properties, of which 3 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-result-structure.json",
  "name": "YodaResult",
  "description": "JSON Structure for the standard Yoda API response envelope used by all Core and Datarequest operations.",
  "type": "object",
  "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": {
      "type": "any",
      "description": "Operation-specific payload; object, array, scalar, or null."
    }
  },
  "required": ["status", "status_info", "data"]
}