< API Documentation Home

Surveillance Data

Data Type: surveillance

Primary Key: id

Attributes

additional_metadata ( array of case insensitive strings)
alcohol_or_other_drug_dependence ( case insensitive string)
breastfeeding ( case insensitive string)
chest_imaging_interpretation ( case insensitive string)
chronic_conditions ( array of case insensitive strings)
collection_city ( case insensitive string)
collection_country ( case insensitive string)
collection_date ( date)
collection_latitude ( number)
collection_longitude ( number)
collection_poi ( case insensitive string)
collection_season ( case insensitive string)
collection_state_province ( case insensitive string)
collection_year ( case insensitive string)
collector_institution ( case insensitive string)
collector_name ( array of case insensitive strings)
comments ( array of case insensitive strings)
contact_email_address ( case insensitive string)
contributing_institution ( case insensitive string)
date_inserted ( date)
date_modified ( date)
daycare_attendance ( case insensitive string)
days_elapsed_to_disease_status ( case insensitive string)
days_elapsed_to_sample_collection ( case insensitive string)
days_elapsed_to_vaccination ( array of case insensitive strings)
diagnosis ( array of case insensitive strings)
dialysis ( case insensitive string)
disease_severity ( case insensitive string)
disease_status ( case insensitive string)
duration_of_exposure ( array of case insensitive strings)
duration_of_treatment ( array of case insensitive strings)
ecmo ( case insensitive string)
education ( case insensitive string)
embargo_end_date ( date)
exposure ( array of case insensitive strings)
exposure_type ( array of case insensitive strings)
genome_id ( array of strings)
geographic_group ( case insensitive string)
hospitalization_duration ( case insensitive string)
hospitalized ( case insensitive string)
host_age ( case insensitive string)
host_capture_status ( case insensitive string)
host_common_name ( case insensitive string)
host_ethnicity ( array of case insensitive strings)
host_group ( case insensitive string)
host_habitat ( case insensitive string)
host_health ( case insensitive string)
host_height ( case insensitive string)
host_id_type ( case insensitive string)
host_identifier ( string)
host_natural_state ( case insensitive string)
host_race ( array of case insensitive strings)
host_sex ( case insensitive string)
host_species ( case insensitive string)
host_weight ( case insensitive string)
human_leukocyte_antigens ( case insensitive string)
id * ( string)
infections_within_five_years ( array of case insensitive strings)
influenza_like_illness_over_the_past_year ( case insensitive string)
initiation_of_treatment ( array of case insensitive strings)
intensive_care_unit ( case insensitive string)
last_update_date ( date)
longitudinal_study ( case insensitive string)
maintenance_medication ( array of case insensitive strings)
nursing_home_residence ( case insensitive string)
onset_hours ( case insensitive string)
other_vaccinations ( case insensitive string)
oxygen_saturation ( case insensitive string)
packs_per_day_for_how_many_years ( case insensitive string)
pathogen_test_interpretation ( array of case insensitive strings)
pathogen_test_result ( array of case insensitive strings)
pathogen_test_type ( array of case insensitive strings)
pathogen_type ( case insensitive string)
post_visit_medications ( array of case insensitive strings)
pre_visit_medications ( array of case insensitive strings)
pregnancy ( case insensitive string)
primary_living_situation ( case insensitive string)
profession ( case insensitive string)
project_identifier ( string)
sample_accession ( string)
sample_identifier ( string)
sample_material ( case insensitive string)
sample_receipt_date ( case insensitive string)
sample_transport_medium ( case insensitive string)
sequence_accession ( array of strings)
source_of_vaccine_information ( array of case insensitive strings)
species ( case insensitive string)
strain ( case insensitive string)
submission_date ( date)
subtype ( case insensitive string)
sudden_onset ( case insensitive string)
symptoms ( array of case insensitive strings)
taxon_lineage_ids ( array of strings)
tobacco_use ( case insensitive string)
travel_history ( array of case insensitive strings)
treatment ( array of case insensitive strings)
treatment_dosage ( array of case insensitive strings)
treatment_type ( array of case insensitive strings)
trimester_of_pregnancy ( case insensitive string)
types_of_allergies ( array of case insensitive strings)
use_of_personal_protective_equipment ( array of case insensitive strings)
vaccination_type ( case insensitive string)
vaccine_dosage ( array of case insensitive strings)
vaccine_lot_number ( array of case insensitive strings)
vaccine_manufacturer ( array of case insensitive strings)
ventilation ( case insensitive string)

API

GET :id

Retrieve a surveillance data object by id

EXAMPLE

https://www.bv-brc.org/api/surveillance/0013cd6a-57a3-4bac-80a8-5d85751c38cd

Try It!

QUERY :query

Query for surveillance data objects with an RQL Query

Return Formats

Requests may include an HTTP ACCEPT header from this list to transform the data into the requested type.

application/json - Returns results as an array of JSON objects
application/solr+json - Results results in SOLR JSON response format
text/csv - Returns results in Comma Separated values (CSV) format. Columns are separated by ','. Multi-value columns are separated by ';'. Rows are separated by new line
text/tsv - Returns results in Tab Separated values (TSV) format. Columns are separated by a tab. Multi-value columns are separated by ';'. Rows are separated by new line
application/vnd.openxmlformats - Returns objects as an MS Excel document

EXAMPLE

Query for surveillance data objects with a id equal to 0013cd6a-57a3-4bac-80a8-5d85751c38cd. Return results as a JSON Array.
```
https://www.bv-brc.org/api/surveillance/?eq(id,0013cd6a-57a3-4bac-80a8-5d85751c38cd)
```
Try It!