Wiki
Clone wikienterobase-web / api_loci
Top level links:
- Main top level page for all documentation
- EnteroBase Features
- Registering on EnteroBase and logging in
- Tutorials
- Using the API
- About the underlying pipelines and other internals
- How schemes in EnteroBase work
- FAQ
The loci query method
Refer to interactive documentation : http://enterobase.warwick.ac.uk/api/v2.0/swagger-ui#!/Loci
The loci
query method shows metadata for loci for genotyping schemes. This includes links
allowing download of the allele sequences for the loci (in gzipped FASTA files).
An example of this type of query to try in the interactive documentation which is also on the page about downloading schemes has "database" set to "senterica", "scheme" set to "MLST_Achtman" (as a parameter and in the path) and "limit" set to "50". This corresponds to an HTTP request to the URL:
http://enterobase.warwick.ac.uk/api/v2.0/senterica/MLST_Achtman/loci?limit=50&scheme=MLST_Achtman
This gives the result:
{ "links": { "paging": {}, "records": 7, "total_records": 7 }, "loci": [ { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=aroC&scheme=UoW&species=Salmonella", "locus": "aroC", "locus_barcode": "SAL_AA0001AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=dnaN&scheme=UoW&species=Salmonella", "locus": "dnaN", "locus_barcode": "SAL_AA0002AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=hemD&scheme=UoW&species=Salmonella", "locus": "hemD", "locus_barcode": "SAL_AA0003AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=hisD&scheme=UoW&species=Salmonella", "locus": "hisD", "locus_barcode": "SAL_AA0004AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=purE&scheme=UoW&species=Salmonella", "locus": "purE", "locus_barcode": "SAL_AA0005AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=sucA&scheme=UoW&species=Salmonella", "locus": "sucA", "locus_barcode": "SAL_AA0006AA_LO", "scheme": "UoW" }, { "database": "Salmonella", "download_alleles_link": "http://enterobase.warwick.ac.uk/download_data?allele=thrA&scheme=UoW&species=Salmonella", "locus": "thrA", "locus_barcode": "SAL_AA0007AA_LO", "scheme": "UoW" } ] }
Updated