Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 1.53 KB

Survey.md

File metadata and controls

16 lines (12 loc) · 1.53 KB

uclapi.Survey

Properties

Name Type Description Notes
id Number The library survey's ID. This is used later to identify individual libraries. [optional]
name String The human-readable name of the library. [optional]
active Boolean Whether the survey is active and working. [optional]
startTime String Standard UCL opening time supplied by the backend. This field should NOT be trusted as information on when a particular library is open. This is usually set to 09:00. [optional]
endTime String Standard UCL closing time supplied by the backend. This field should NOT be trusted as information on when a particular library closes. This is usually set to 17:00. [optional]
staffSurvey Boolean Whether the survey represents a staff workspace (`true`) or a student work or study space (`false`). This is useful in apps where you set the `survey_filter` parameter to `all` and wish to do filtering of student and staff workspaces in your app or API as opposed to leaving the filtering to UCL API. By default, as `survey_filter` is set to `student` unless you specify otherwise, all workspaces will have this parameter set to `false`. [optional]
maps [Object] List of maps corresponding to regions within the library's survey. [optional]
location SurveyLocation [optional]