< API Documentation Home

Serology Data

Data Type: serology

Primary Key: id

Attributes

additional_metadata ( array of case insensitive strings)
collection_city ( case insensitive string)
collection_country ( case insensitive string)
collection_date ( date)
collection_state ( case insensitive string)
collection_year ( case insensitive string)
comments ( array of case insensitive strings)
contributing_institution ( case insensitive string)
date_inserted ( date)
date_modified ( date)
genbank_accession ( array of case insensitive strings)
geographic_group ( case insensitive string)
host_age ( case insensitive string)
host_age_group ( case insensitive string)
host_common_name ( case insensitive string)
host_health ( case insensitive string)
host_identifier ( string)
host_sex ( case insensitive string)
host_species ( case insensitive string)
host_type ( array of case insensitive strings)
id * ( string)
positive_definition ( case insensitive string)
project_identifier ( string)
sample_accession ( string)
sample_identifier ( string)
serotype ( array of case insensitive strings)
strain ( case insensitive string)
taxon_lineage_ids ( array of strings)
test_antigen ( case insensitive string)
test_interpretation ( case insensitive string)
test_pathogen ( case insensitive string)
test_result ( case insensitive string)
test_type ( case insensitive string)
virus_identifier ( case insensitive string)

API

GET :id

Retrieve a serology data object by id

EXAMPLE

https://www.bv-brc.org/api/serology/00073888-0195-4be6-b236-dde956a6171e

Try It!

QUERY :query

Query for serology 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 serology data objects with a id equal to 00073888-0195-4be6-b236-dde956a6171e. Return results as a JSON Array.
```
https://www.bv-brc.org/api/serology/?eq(id,00073888-0195-4be6-b236-dde956a6171e)
```
Try It!