UCL · JSON Structure

Ucl User Data Structure

JSON Structure for the UCL API 'user_data' object, derived from the UCL API OpenAPI 3.0 description.

Type: object Properties: 9
EducationHigher EducationUniversityUnited KingdomOpen DataResearchLibraryTimetable

UserData is a JSON Structure definition published by UCL, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ok email full_name department cn given_name upi scope_number is_student

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/ucl/main/json-structure/ucl-user-data-structure.json",
  "name": "UserData",
  "type": "object",
  "description": "JSON Structure for the UCL API 'user_data' object, derived from the UCL API OpenAPI 3.0 description.",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "email": {
      "type": "string"
    },
    "full_name": {
      "type": "string"
    },
    "department": {
      "type": "string"
    },
    "cn": {
      "type": "string"
    },
    "given_name": {
      "type": "string"
    },
    "upi": {
      "type": "string"
    },
    "scope_number": {
      "type": "number"
    },
    "is_student": {
      "type": "boolean"
    }
  }
}