UCL · Schema

UCL API user_data

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

EducationHigher EducationUniversityUnited KingdomOpen DataResearchLibraryTimetable

Properties

Name Type Description
ok boolean
email string
full_name string
department string
cn string
given_name string
upi string
scope_number number
is_student boolean
View JSON Schema on GitHub

JSON Schema

ucl-user-data-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ucl/main/json-schema/ucl-user-data-schema.json",
  "title": "UCL API user_data",
  "description": "JSON Schema for the UCL API 'user_data' object, derived from the UCL API OpenAPI 3.0 description.",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "examples": [
        "true"
      ]
    },
    "email": {
      "type": "string",
      "examples": [
        "[email protected]"
      ]
    },
    "full_name": {
      "type": "string",
      "examples": [
        "John Doe"
      ]
    },
    "department": {
      "type": "string",
      "examples": [
        "Dept of Computer Science"
      ]
    },
    "cn": {
      "type": "string",
      "examples": [
        "xxxxxxx"
      ]
    },
    "given_name": {
      "type": "string",
      "examples": [
        "John"
      ]
    },
    "upi": {
      "type": "string",
      "examples": [
        "jdoe12"
      ]
    },
    "scope_number": {
      "type": "number",
      "examples": [
        0
      ]
    },
    "is_student": {
      "type": "boolean",
      "examples": [
        true
      ]
    }
  }
}