Difference between revisions of "OJ Break API Reference"
Jump to navigation
Jump to search
(→Return) |
(Updated the page to point to the new api urls.) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
| − | + | The reference for version 2 of the API can be found here: [[OJ_Break_Version_2_API_Reference]] | |
| − | |||
| − | |||
| − | To read more about using the OJ_Break API, go to [[OJ_Break API Access]]. | + | == API Information and Access == |
| + | This page specifies the methods and data defined by OJ_Break Version 1. Using the OJ_Break Version 1 API requires calling methods with corresponding, method specific parameters (found in this page) and a few other required parameters. These include specifying a return ''format'' and an API access ''key''. | ||
| + | |||
| + | Example: https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | ||
| + | |||
| + | To read more about using the OJ_Break Version 1 API, go to [[OJ_Break API Access]]. | ||
== Procedural Reference == | == Procedural Reference == | ||
| Line 20: | Line 23: | ||
* ''key'': string | * ''key'': string | ||
===== Return ===== | ===== Return ===== | ||
| − | * ''collector_info'' | + | * ''collector_info'': array of author_info |
| + | |||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectorInfo?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getAuthorPubs ==== | ==== getAuthorPubs ==== | ||
| Line 31: | Line 35: | ||
* ''key'': string | * ''key'': string | ||
===== Return ===== | ===== Return ===== | ||
| + | * ''pubs'': array of literature_extended | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorPubs?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getCollTrips2 ==== | ==== getCollTrips2 ==== | ||
| Line 42: | Line 47: | ||
* ''key'': string | * ''key'': string | ||
===== Return ===== | ===== Return ===== | ||
| − | * ''coll_trips'': array of | + | * ''coll_trips'': array of collection_basic, taxon_basic, loc_coords, and collector. |
| − | |||
| − | |||
| − | |||
| − | |||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollTrips2?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getAuthorTaxa ==== | ==== getAuthorTaxa ==== | ||
===== Description ===== | ===== Description ===== | ||
===== Parameters ===== | ===== Parameters ===== | ||
| + | * ''author_id'': number | ||
| + | * ''format'': string | ||
| + | * ''key'': string | ||
| + | |||
===== Return ===== | ===== Return ===== | ||
| + | ''taxa'': array of taxon_basic | ||
| + | |||
===== Example ===== | ===== Example ===== | ||
| + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorTaxa?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | ||
| + | |||
=== Taxon === | === Taxon === | ||
==== getTaxonStats ==== | ==== getTaxonStats ==== | ||
| Line 70: | Line 79: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonInfo ==== | ==== getTaxonInfo ==== | ||
| Line 91: | Line 100: | ||
* ''contribs'': array of contribution | * ''contribs'': array of contribution | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonInfo?tnuid=30148&inst_id=0&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonHierarchy ==== | ==== getTaxonHierarchy ==== | ||
| Line 105: | Line 114: | ||
* ''hier'': taxon_hierarchy | * ''hier'': taxon_hierarchy | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getIncludedTaxa ==== | ==== getIncludedTaxa ==== | ||
| Line 125: | Line 134: | ||
* ''includedTaxa'': array of taxon_extended | * ''includedTaxa'': array of taxon_extended | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getIncludedTaxa?tnuid=491&inst_id=0&showSyns=Y&showFossils=Y&types_only=N&show_num_spms=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonSynonyms ==== | ==== getTaxonSynonyms ==== | ||
| Line 139: | Line 148: | ||
* ''synonyms'': array of taxon_rel_extended | * ''synonyms'': array of taxon_rel_extended | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonSynonyms?tnuid=30148&showFossils=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getLocalities ==== | ==== getLocalities ==== | ||
| Line 155: | Line 164: | ||
* ''localities'': array of loc_coords | * ''localities'': array of loc_coords | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalities?tnuid=30148&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getLocalities ==== | ==== getLocalities ==== | ||
| Line 172: | Line 181: | ||
* ''localities'': array of loc_coords | * ''localities'': array of loc_coords | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalities?tnuid=30148&pnids=5816,5735&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getCuids ==== | ==== getCuids ==== | ||
| Line 188: | Line 197: | ||
* ''cuids'': array of cuid | * ''cuids'': array of cuid | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuids?tnuid=30148&showChildren=Y&inst_id=1&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getCuids ==== | ==== getCuids ==== | ||
| Line 202: | Line 211: | ||
* ''cuids'': array of cuid | * ''cuids'': array of cuid | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTypes ==== | ==== getTypes ==== | ||
| Line 224: | Line 233: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTypes?tnuid=434&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getInsts ==== | ==== getInsts ==== | ||
| Line 239: | Line 248: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonLiterature (deprecated) ==== | ==== getTaxonLiterature (deprecated) ==== | ||
| Line 253: | Line 262: | ||
* ''lit'': pubs | * ''lit'': pubs | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonLit ==== | ==== getTaxonLit ==== | ||
| Line 268: | Line 277: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getAssociations ==== | ==== getAssociations ==== | ||
| Line 283: | Line 292: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAssociations?tnuid=491&rank_grouping=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getHabitats ==== | ==== getHabitats ==== | ||
| Line 298: | Line 307: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonMedia ==== | ==== getTaxonMedia ==== | ||
| Line 312: | Line 321: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonBreakdown ==== | ==== getTaxonBreakdown ==== | ||
| Line 328: | Line 337: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonBreakdown?tnuid=491&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonPhenology ==== | ==== getTaxonPhenology ==== | ||
| Line 345: | Line 354: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonPhenology?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonNewTaxaByPub ==== | ==== getTaxonNewTaxaByPub ==== | ||
| Line 361: | Line 370: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonNewTaxaByYear ==== | ==== getTaxonNewTaxaByYear ==== | ||
| Line 378: | Line 387: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxonStatsForYear ==== | ==== getTaxonStatsForYear ==== | ||
| Line 401: | Line 410: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Occurrence === | === Occurrence === | ||
| Line 416: | Line 425: | ||
* ''spmInfo'': record_vouchered | * ''spmInfo'': record_vouchered | ||
====== Example ====== | ====== Example ====== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
===== getSpmsInfo ===== | ===== getSpmsInfo ===== | ||
| Line 429: | Line 438: | ||
* ''spmsInfo'': array of record_vouchered | * ''spmsInfo'': array of record_vouchered | ||
====== Example ====== | ====== Example ====== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== Unvouchered Record ==== | ==== Unvouchered Record ==== | ||
| Line 444: | Line 453: | ||
====== Example ====== | ====== Example ====== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
===== getUnvoucheredRecords ===== | ===== getUnvoucheredRecords ===== | ||
| Line 460: | Line 469: | ||
====== Example ====== | ====== Example ====== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Locality === | === Locality === | ||
| Line 484: | Line 493: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalityInfo?loc_id=1&tnuid=30148&inst_id=1&per_id=1&pnid=1&showChildren=Y&completeSpmInfo=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getUnvLocalityInfo ==== | ==== getUnvLocalityInfo ==== | ||
| Line 504: | Line 513: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvLocalityInfo?loc_id=1&tnuid=30148&per_id=1&pnid=1&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Place / Geopolitical Entity === | === Place / Geopolitical Entity === | ||
| Line 522: | Line 531: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getSubdivisions ==== | ==== getSubdivisions ==== | ||
| Line 536: | Line 545: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getGeoTaxa ==== | ==== getGeoTaxa ==== | ||
| Line 555: | Line 564: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getGeoCollTrips ==== | ==== getGeoCollTrips ==== | ||
| Line 569: | Line 578: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getGeoCollTrips2 ==== | ==== getGeoCollTrips2 ==== | ||
| Line 585: | Line 594: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getGeoInsts ==== | ==== getGeoInsts ==== | ||
| Line 599: | Line 608: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Literature === | === Literature === | ||
| Line 614: | Line 623: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getLitParts ==== | ==== getLitParts ==== | ||
| Line 628: | Line 637: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitParts?pub_id=20239&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getPubTaxonCitation ==== | ==== getPubTaxonCitation ==== | ||
| Line 646: | Line 655: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getPubAssocCitation ==== | ==== getPubAssocCitation ==== | ||
| Line 659: | Line 668: | ||
* ''assoc_cits'': array of .. | * ''assoc_cits'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubAssocCitation?pub_id=23683&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Journal === | === Journal === | ||
| Line 682: | Line 691: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getJournalPubs ==== | ==== getJournalPubs ==== | ||
| Line 696: | Line 705: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getJournalTaxa ==== | ==== getJournalTaxa ==== | ||
| Line 709: | Line 718: | ||
* ''taxa'': array of taxon_basic | * ''taxa'': array of taxon_basic | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Institution === | === Institution === | ||
| Line 732: | Line 741: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getPrimaryTypes ==== | ==== getPrimaryTypes ==== | ||
| Line 746: | Line 755: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getSecondaryTypes ==== | ==== getSecondaryTypes ==== | ||
| Line 760: | Line 769: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getInstTaxa ==== | ==== getInstTaxa ==== | ||
| Line 775: | Line 784: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getInstCollTrips2 ==== | ==== getInstCollTrips2 ==== | ||
| Line 789: | Line 798: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getInstPubs ==== | ==== getInstPubs ==== | ||
| Line 803: | Line 812: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
=== Text Search === | === Text Search === | ||
| Line 845: | Line 854: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSearchResults?name=%OSU%&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getTaxaFromText ==== | ==== getTaxaFromText ==== | ||
| Line 863: | Line 872: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getCuidsFromText ==== | ==== getCuidsFromText ==== | ||
| Line 879: | Line 888: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuidsFromText?name=%OSUC%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getAgentsFromText ==== | ==== getAgentsFromText ==== | ||
| Line 900: | Line 909: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAgentsFromText?name=%Johnson,%20N.%20F.%&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getInstFromText ==== | ==== getInstFromText ==== | ||
| Line 916: | Line 925: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstFromText?name=Hymenoptera&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getJournalsFromText ==== | ==== getJournalsFromText ==== | ||
| Line 934: | Line 943: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalsFromText?name=Insect&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getOrgsFromText ==== | ==== getOrgsFromText ==== | ||
| Line 952: | Line 961: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getOrgsFromText?name=%Geo%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getPlacesFromText ==== | ==== getPlacesFromText ==== | ||
| Line 969: | Line 978: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlacesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getLocalitiesFromText ==== | ==== getLocalitiesFromText ==== | ||
| Line 987: | Line 996: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalitiesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
==== getCollMethodsFromText ==== | ==== getCollMethodsFromText ==== | ||
| Line 1,005: | Line 1,014: | ||
===== Example ===== | ===== Example ===== | ||
| − | + | https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollMethodsFromText?name=reared&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC | |
== Data Type Glossary == | == Data Type Glossary == | ||
Latest revision as of 14:57, 9 July 2018
Introduction
OJ_Break is the name of the xBio:D RESTful API service to facilitate discovery of data within the xBio:D database. The API can respond with JavaScript Object Notation (JSON), XML, or JSON with padding (JSONP) and accepts HTTP GET and POST requests indiscriminately. The backend of the API is written in Oracle's PL/SQL database language, which is fast but often inflexible, while a Python presentation layer mitigates request handling and authentication.
The reference for version 2 of the API can be found here: OJ_Break_Version_2_API_Reference
Contents
- 1 API Information and Access
- 2 Procedural Reference
- 2.1 Agent
- 2.2 Taxon
- 2.2.1 getTaxonStats
- 2.2.2 getTaxonInfo
- 2.2.3 getTaxonHierarchy
- 2.2.4 getIncludedTaxa
- 2.2.5 getTaxonSynonyms
- 2.2.6 getLocalities
- 2.2.7 getLocalities
- 2.2.8 getCuids
- 2.2.9 getCuids
- 2.2.10 getTypes
- 2.2.11 getInsts
- 2.2.12 getTaxonLiterature (deprecated)
- 2.2.13 getTaxonLit
- 2.2.14 getAssociations
- 2.2.15 getHabitats
- 2.2.16 getTaxonMedia
- 2.2.17 getTaxonBreakdown
- 2.2.18 getTaxonPhenology
- 2.2.19 getTaxonNewTaxaByPub
- 2.2.20 getTaxonNewTaxaByYear
- 2.2.21 getTaxonStatsForYear
- 2.3 Occurrence
- 2.4 Locality
- 2.5 Place / Geopolitical Entity
- 2.6 Literature
- 2.7 Journal
- 2.8 Institution
- 2.9 Text Search
- 3 Data Type Glossary
API Information and Access
This page specifies the methods and data defined by OJ_Break Version 1. Using the OJ_Break Version 1 API requires calling methods with corresponding, method specific parameters (found in this page) and a few other required parameters. These include specifying a return format and an API access key.
Example: https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
To read more about using the OJ_Break Version 1 API, go to OJ_Break API Access.
Procedural Reference
Agent
getCollectorInfo
Description
Parameters
- collector_id: number
- format: string
- key: string
Return
- collector_info: array of author_info
Example
getAuthorPubs
Description
Parameters
- author_id: number
- format: string
- key: string
Return
- pubs: array of literature_extended
Example
getCollTrips2
Description
Parameters
- collector_id: number
- format: string
- key: string
Return
- coll_trips: array of collection_basic, taxon_basic, loc_coords, and collector.
Example
getAuthorTaxa
Description
Parameters
- author_id: number
- format: string
- key: string
Return
taxa: array of taxon_basic
Example
Taxon
getTaxonStats
Description
Get some basic taxonomic statistics for a taxon from a tnuid.
Parameters
- tnuid: number
- format: string
- key: string
Return
- taxon: string
- author: string
- stats: taxon_stats
Example
getTaxonInfo
Description
Get some basic taxonomic information for a taxon from a tnuid.
Parameters
- tnuid: number
- inst_id: number
- format: string
- key: string
Return
- taxon_rel_extended class with below extensions
- valid_taxon: taxon_basic (only present when defined)
- parent_taxon: taxon_basic
- hier: taxon_hierarchy
- source: taxon_source
- common_names: array of common_name
- orig_desc: contrib_literature_basic (only present when defined)
- stats: taxon_info_stats
- contribs: array of contribution
Example
getTaxonHierarchy
Description
Get the taxonomic hierarachy in which a taxon is at the terminal node from a tnuid.
Parameters
- tnuid: number
- format: string
- key: string
Return
- taxon: string
- author: string
- hier: taxon_hierarchy
Example
getIncludedTaxa
Description
Get the taxa that are directly included within a taxon but not synonymous with it.
Parameters
- tnuid: number
- inst_id: number
- showSyns: boolean_flag
- showFossils: boolean_flag
- types_only: boolean_flag
- show_num_spms: boolean_flag
- format: string
- key: string
Return
- tnuid: number
- parent_tnuid: number
- includedTaxa: array of taxon_extended
Example
getTaxonSynonyms
Description
Get the taxa that are objectively or subjectively synonymous with a taxon.
Parameters
- tnuid: number
- showFossils: boolean_flag
- format: string
- key: string
Return
- synonyms: array of taxon_rel_extended
Example
getLocalities
Description
Get the localities from vouchered and unvouchered records for a taxon.
Parameters
- tnuid: number
- inst_id: number
- precDecimals: number
- showChildren: boolean_flag
- format: string
- key: string
Return
- localities: array of loc_coords
Example
getLocalities
Description
Get the localities within geopolitical divisions from vouchered and unvouchered records for a taxon.
Parameters
- tnuid: number
- pnids: array of pnid
- inst_id: number
- precDecimals: number
- showChildren: boolean_flag
- format: string
- key: string
Return
- localities: array of loc_coords
Example
getCuids
Description
Get the occurrence identifiers (collecting unit IDs) for a taxon.
Parameters
- tnuid: number
- showChildren: boolean_flag
- inst_id: number
- pnids: array of pnid
- format: string
- key: string
Return
- cuids: array of cuid
Example
getCuids
Description
Get the occurrence identifiers (collecting unit IDs) for selected taxa.
Parameters
- tnuids: array of tnuid
- pnids: array of pnid
- format: string
- key: string
Return
- cuids: array of cuid
Example
getTypes
Description
Gets information and specimen types for a specified taxon.
Parameters
- tnuid: number
- showSyns: boolean_flag
- inst_id: number
- primary_only: boolean_flag
- taxon_author_search: string
- offset: number
- limit: number
- format: string
- key: string
Return
- num_records: number
- types: array of type_extended
Example
getInsts
Description
Gets institutions which hold specimens for a selected taxon.
Parameters
- tnuid: number
- format: string
- key: string
Return
- collections: array of collection_extended
Example
getTaxonLiterature (deprecated)
Description
Deprecated. Use getTaxonLit instead
Parameters
- tnuid: number
- showSyns: string
- format: string
- key: string
Return
- lit: pubs
Example
getTaxonLit
Description
Preferred. Get literature for a selected taxon.
Parameters
- tnuid: number
- showSyns: boolean_flag
- format: string
- key: string
Return
- pubs: array of pub_extended
Example
getAssociations
Description
Get evolutionary relationships for a certain taxon.
Parameters
- tnuid: number
- rank_grouping: string
- format: string
- key: string
Return
- associations: array of association
Example
getHabitats
Description
Get descriptions of the habitats that a selected specimen inhabits.
Parameters
- tnuid: number
- format: string
- key: string
Return
- habitats: array of habitat
Example
getTaxonMedia
Description
Get images, videos, or sound clips of a selected taxon.
Parameters
- tnuid: number
- format: string
- key: string
Return
- media: array of media_basic
Example
getTaxonBreakdown
Description
Get count of genders and total specimen included in the current rank.
Parameters
- tnuid: number
- format: string
- key: string
Return
- taxa: array of taxon_basic with below extension
- count: number
- sex: array of spm_sex
Example
getTaxonPhenology
Description
Get taxon specimens by date.
Parameters
- tnuid: number
- format: string
- key: string
Return
- spms: array of below elements
- date: string
- sort_date: string
- cuid: string
Example
getTaxonNewTaxaByPub
Description
Get count of new specimens for a specific taxon by publication.
Parameters
- tnuid: number
- validOnly: boolean_flag
- format: string
- key: string
Return
- pubs: array of literature_extended with below extension
- taxa_num: string
Example
getTaxonNewTaxaByYear
Description
Get count of new specimens for a specific taxon by year.
Parameters
- tnuid: number
- validOnly: string
- format: string
- key: string
Return
- years: array of below elements
- taxa_num: string
- year: string
Example
getTaxonStatsForYear
Description
Get stats, such as image count, new genera introduced, new specimen introduced, and more by year for a selected taxon.
Parameters
- tnuid: number
- stats_year: number
- format: string
- key: string
Return
- stats: array of below elements
- new_spm_num: number
- all_spm_num: number
- new_taxa_spm_num: array of number
- all_taxa_spm_num: array of number
- new_images_num: number
- all_images_num: number
- spm_years: array of string
- images_years: array of string
Example
Occurrence
Specimen Record
getSpmInfo
Description
Get info for a specific specimen occurrence.
Parameters
- cuid: string
- format: string
- key: string
Return
- spmInfo: record_vouchered
Example
getSpmsInfo
Description
Get info for multiple specimen occurrences.
Parameters
- cuids: array of string
- format: string
- key: string
Return
- spmsInfo: array of record_vouchered
Example
Unvouchered Record
getUnvoucheredRecord
Description
Get specimen record information for a selected unvouchered specimen.
Parameters
- unv_id: number
- format: string
- key: string
Return
- unvoucheredRecord: record_unvouchered
Example
getUnvoucheredRecords
Description
Get unvouchered specimen records for a selected taxon and place.
Parameters
- tnuid: number
- showChildren: string
- pnids: array of number
- format: string
- key: string
Return
- unvoucheredRecords: array of record_unvouchered
Example
Locality
getLocalityInfo
Description
Get basic information for a specific locality, including specimen occurrences, place hierarchy, and coordinates.
Parameters
- loc_id: number
- tnuid: number
- inst_id: number
- per_id: number
- pnid: number
- showChildren: string
- completeSpmInfo: string
- format: string
- key: string
Return
- locInfo: array of loc_info with below extensions
- hier: array of place
- cuids: array of record_vouchered (only present if specified) or array of cuid
- sex: array of spm_sex
Example
getUnvLocalityInfo
Description
Get locality information and occurrences (specimens) for a selected locality. The request can be narrowed down further by selected multiple parameter options.
Parameters
- loc_id: number
- tnuid: number
- per_id: number
- pnid: number
- showChildren: string
- format: string
- key: string
Return
- locInfo: loc_info with below extensions
- hier: array of place
- cuids: array of cuid
Example
Place / Geopolitical Entity
getPlaceInfo
Description
Get basic place information including the place hierarchy, number of specimens, and number of species.
Parameters
- place_id: number
- format: string
- key: string
Return
- place_info: place with below extension
- hier: array of place
- num_species: number
- num_spms: number
Example
getSubdivisions
Description
Get smaller levels of divisions for a selected place.
Parameters
- place_id: number
- format: string
- key: string
Return
- subdivs: array of place
Example
getGeoTaxa
Description
Get taxonomic information from a specified place.
Parameters
- place_id: number
- format: string
- key: string
Return
- taxa: array of taxon_basic with below extensions
- valid_taxon: taxon_basic (only present when defined)
- hier: taxon_hierarchy
- count: number
- rank: string
Example
getGeoCollTrips
Description
Get collecting trips info for a specified place.
Parameters
- place_id: number
- format: string
- key: string
Return
- coll_trips: array of loc_basic and collector.
Example
getGeoCollTrips2
Description
Get collecting trips and taxa info for a specified place.
Parameters
- place_id: number
- format: string
- key: string
Return
- coll_trips: array of taxon_basic, collection, collector and loc_basic with below extension
- valid_taxon: taxon_basic (only present when defined)
Example
getGeoInsts
Description
Get institutions from a selected place.
Parameters
- place_id: number
- format: string
- key: string
Return
- collections: array of collection_extended
Example
Literature
getLitReference
Description
Get the reference for a selected publication.
Parameters
- pub_id: number
- format: string
- key: string
Return
- pub_ref: literature_extended
Example
getLitParts
Description
Get parts of the selected publication, such as pages, pdf urls, chapters, titles, authors, and more.
Parameters
- pub_id: number
- format: string
- key: string
Return
- pub_parts: array of literature_extended
Example
getPubTaxonCitation
Description
Get cited taxon information from a selected publication.
Parameters
- pub_id: number
- format: string
- key: string
Return
- pub_cits: array of pub_basic and taxon_basic with below extensions
- tnucid: number
- rank: string
- public: string
- author: string
Example
getPubAssocCitation
Description
Parameters
- pub_id: number
- format: string
- key: string
Return
- assoc_cits: array of ..
Example
Journal
getJournalInfo
Description
Parameters
- jrnl_id: number
- format: string
- key: string
Return
- journal_info: array of below elements
- name: string
- url: string
- is_public: string
- copyright_holder: string
- num_articles: number
- num_pdfs: number
- num_taxa: number
- last_article_time: string
Example
getJournalPubs
Description
Parameters
- jrnl_id: number
- format: string
- key: string
Return
- pubs: array of literature_extended
Example
getJournalTaxa
Description
Parameters
- jrnl_id: number
- format: string
- key: string
Return
- taxa: array of taxon_basic
Example
Institution
getCollectionInfo
Description
Parameters
- inst_id: number
- format: string
- key: string
Return
- collection_info: array of collection_extended with below extensions
- vouchered: boolean
- num_prim_types: number
- num_sec_types: number
- num_species: number
- last_spm_time: string
- oldest_spm: array of below elements
- cuid: string
- coll_date: string
Example
getPrimaryTypes
Description
Get specimen of which the description of a new species is based.
Parameters
- inst_id: number
- format: string
- key: string
Return
- types: array of type
Example
getSecondaryTypes
Description
Get specimen that are occurrences of a specific species, but not a primary type.
Parameters
- inst_id: number
- format: string
- key: string
Return
- types: array of type
Example
getInstTaxa
Description
Get taxa and related taxonomic information from a selected institution.
Parameters
- inst_id: number
- format: string
- key: string
Return
- taxa: array of taxon_extended with below extension
- hier: taxon_hierarchy
Example
getInstCollTrips2
Description
Get collecting trip events and the specimen collected for a selected institution.
Parameters
- inst_id: number
- format: string
- key: string
Return
- coll_trips: array of taxon_basic, collection, collector, and loc_basic.
Example
getInstPubs
Description
Get published literature from a selected institution.
Parameters
- inst_id: number
- format: string
- key: string
Return
- pubs: array of literature_extended
Example
Text Search
getSearchResults
Description
Get database results from a text keyword search.
Parameters
- name: string
- limit: number
- categoryLimit: string
- format: string
- key: string
Return
- taxon_results: array of below extensions
- taxa: array of taxon_extended with below extension
- lsid: number
- count: number
- taxa: array of taxon_extended with below extension
- cuid_results: array of below extensions
- cuids: array of cuids
- count: number
- agent_results: array of below extensions
- agents: array of below extensions
- type: string
- id: number
- name: string
- inst: string
- count: number
- agents: array of below extensions
- inst_results: array of below extensions
- inst: array of collection_extended
- count: number
- place_results: array of below extensions
- places: array of place with below extension
- hier: array of place
- count: number
- places: array of place with below extension
- journal_results: array of below extensions
- journals: array of below extensions
- name: string
- id: number
- count: number
- journals: array of below extensions
Example
getTaxaFromText
Description
Get taxa results from a selected search keyword.
Parameters
- name: string
- limit: number
- nameOnly: string
- format: string
- key: string
Return
- taxa: array of taxon_extended with below extensions
- lsid: number
- count: number
Example
getCuidsFromText
Description
Get occurrence results from a selected search keyword.
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- cuids: array of cuid
- count: number
Example
getAgentsFromText
Description
Get agent (person and/or party) results from a selected search keyword.
Parameters
- name: string
- limit: number
- includeParty: string
- format: string
- key: string
Return
- agents: array of below elements
- id: number
- type: string
- name: string
- inst: string
- count: number
Example
getInstFromText
Description
Get institution/collection results from a selected search keyword(s).
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- inst: array of collection_extended
- count: number
Example
getJournalsFromText
Description
Get journal results from a selected search keyword(s).
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- journals: array of below elements
- name: string
- id: number
- count: number
Example
getOrgsFromText
Description
Get organization results for a selected search keyword(s).
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- orgs: array of below elements
- name: string
- id: number
- count: number
Example
getPlacesFromText
Description
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- places: array of place with below extension
- hier: array of place
- count: number
Example
getLocalitiesFromText
Description
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- locs: array of below elements
- name: string
- id: number
- count: number
Example
getCollMethodsFromText
Description
Parameters
- name: string
- limit: number
- format: string
- key: string
Return
- coll_methods: array of below elements
- name: string
- id: number
- count: number
