UCL · Schema
UCL API survey
JSON Schema for the UCL API 'survey' object, derived from the UCL API OpenAPI 3.0 description.
EducationHigher EducationUniversityUnited KingdomOpen DataResearchLibraryTimetable
Properties
| Name | Type | Description |
|---|---|---|
| id | number | |
| name | string | |
| active | boolean | |
| start_time | string | |
| end_time | string | |
| staff_survey | number | |
| maps | array | |
| location | object |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://raw.githubusercontent.com/api-evangelist/ucl/main/json-schema/ucl-survey-schema.json",
"title": "UCL API survey",
"description": "JSON Schema for the UCL API 'survey' object, derived from the UCL API OpenAPI 3.0 description.",
"type": "object",
"properties": {
"id": {
"type": "number",
"examples": [
46
]
},
"name": {
"type": "string",
"examples": [
"UCL Institute of Education Library"
]
},
"active": {
"type": "boolean",
"examples": [
true
]
},
"start_time": {
"type": "string",
"examples": [
"09:00"
]
},
"end_time": {
"type": "string",
"examples": [
"17:00"
]
},
"staff_survey": {
"type": "number",
"examples": [
0
]
},
"maps": {
"type": "array",
"items": {
"$ref": "#/definitions/map"
}
},
"location": {
"type": "object",
"properties": {
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "string",
"examples": [
"51.522897"
]
},
"lng": {
"type": "string",
"examples": [
"-0.127864"
]
}
}
},
"address": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"Newsam Library and Archives",
"20 Bedford Way",
"London",
"WC1H 0AL"
]
]
}
}
}
},
"definitions": {
"map": {
"properties": {
"id": {
"type": "number",
"examples": [
114
]
},
"name": {
"type": "string",
"examples": [
"Level 4"
]
},
"image_id": {
"type": "number",
"examples": [
123
]
}
}
},
"map_with_sensors": {
"properties": {
"id": {
"type": "string",
"examples": [
"73"
]
},
"name": {
"type": "string",
"examples": [
"Level 3"
]
},
"image_id": {
"type": "string",
"examples": [
"79"
]
},
"sensors": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/sensor"
}
}
}
},
"sensor": {
"properties": {
"description_2": {
"type": "string",
"examples": [
""
]
},
"floor": {
"type": "string",
"examples": [
"False"
]
},
"y_pos": {
"type": "string",
"examples": [
"14893.0"
]
},
"description_3": {
"type": "string",
"examples": [
""
]
},
"device_type": {
"type": "string",
"examples": [
"Desk"
]
},
"host_address": {
"type": "string",
"examples": [
"584"
]
},
"building_name": {
"type": "string",
"examples": [
"IOE (20 B-Way)"
]
},
"room_description": {
"type": "string",
"examples": [
""
]
},
"last_trigger_type": {
"type": "string",
"examples": [
"Occupied"
]
},
"survey_id": {
"type": "string",
"examples": [
"46"
]
},
"room_type": {
"type": "string",
"examples": [
"Open Plan"
]
},
"room_name": {
"type": "string",
"examples": [
"324"
]
},
"room_id": {
"type": "string",
"examples": [
"291"
]
},
"location": {
"type": "string",
"examples": [
""
]
},
"survey_device_id": {
"type": "string",
"examples": [
"8420"
]
},
"share_id": {
"type": "string",
"examples": [
"None"
]
},
"x_pos": {
"type": "string",
"examples": [
"32432.0"
]
},
"description_1": {
"type": "string",
"examples": [
""
]
},
"hardware_id": {
"type": "string",
"examples": [
"584001"
]
},
"pir_address": {
"type": "string",
"examples": [
"1"
]
},
"last_trigger_timestamp": {
"type": "string",
"examples": [
"2018-02-15T22:42:28+00:00"
]
},
"occupied": {
"type": "boolean",
"examples": [
true
]
}
}
}
}
}