Difference between revisions of "OJ Break API Reference"
Jump to navigation
Jump to search
(→Procedural Reference) |
|||
| Line 24: | Line 24: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonInfo ==== | ==== getTaxonInfo ==== | ||
| Line 44: | Line 44: | ||
* ''contribs'': array of contribution | * ''contribs'': array of contribution | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=0&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonHierarchy ==== | ==== getTaxonHierarchy ==== | ||
| Line 57: | Line 57: | ||
* ''hier'': taxon_hierarchy | * ''hier'': taxon_hierarchy | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getIncludedTaxa ==== | ==== getIncludedTaxa ==== | ||
| Line 75: | Line 75: | ||
* ''includedTaxa'': array of taxon_extended | * ''includedTaxa'': array of taxon_extended | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getIncludedTaxa?tnuid=491&inst_id=0&showSyns=Y&showFossils=Y&types_only=N&show_num_spms=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonSynonyms ==== | ==== getTaxonSynonyms ==== | ||
| Line 87: | Line 87: | ||
* ''synonyms'': array of taxon_rel_extended | * ''synonyms'': array of taxon_rel_extended | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&showFossils=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getLocalities ==== | ==== getLocalities ==== | ||
| Line 101: | Line 101: | ||
* ''localities'': array of loc_coords | * ''localities'': array of loc_coords | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalities?tnuid=30148&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getLocalities ==== | ==== getLocalities ==== | ||
| Line 116: | Line 116: | ||
* ''localities'': array of loc_coords | * ''localities'': array of loc_coords | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalities?tnuid=30148&pnids=5816,5735&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getCuids ==== | ==== getCuids ==== | ||
| Line 130: | Line 130: | ||
* ''cuids'': array of cuid | * ''cuids'': array of cuid | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCuids?tnuid=30148&showChildren=Y&inst_id=1&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getCuids ==== | ==== getCuids ==== | ||
| Line 142: | Line 142: | ||
* ''cuids'': array of cuid | * ''cuids'': array of cuid | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTypes ==== | ==== getTypes ==== | ||
| Line 169: | Line 169: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTypes?tnuid=52&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
| − | |||
==== getInsts ==== | ==== getInsts ==== | ||
===== Description ===== | ===== Description ===== | ||
| Line 181: | Line 180: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonLiterature (deprecated) ==== | ==== getTaxonLiterature (deprecated) ==== | ||
| Line 193: | Line 192: | ||
* ''lit'': pubs | * ''lit'': pubs | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonLit ==== | ==== getTaxonLit ==== | ||
| Line 205: | Line 204: | ||
* ''pubs'': array of pubs | * ''pubs'': array of pubs | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getAssociations ==== | ==== getAssociations ==== | ||
| Line 222: | Line 221: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getAssociations?tnuid=30148&rank_grouping=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getHabitats ==== | ==== getHabitats ==== | ||
| Line 235: | Line 234: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonMedia ==== | ==== getTaxonMedia ==== | ||
| Line 246: | Line 245: | ||
* ''media'': array of media_basic | * ''media'': array of media_basic | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonBreakdown ==== | ==== getTaxonBreakdown ==== | ||
| Line 259: | Line 258: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonBreakdown?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonPhenology ==== | ==== getTaxonPhenology ==== | ||
| Line 274: | Line 273: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonPhenology?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonNewTaxaByPub ==== | ==== getTaxonNewTaxaByPub ==== | ||
| Line 288: | Line 287: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonNewTaxaByYear ==== | ==== getTaxonNewTaxaByYear ==== | ||
| Line 303: | Line 302: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxonStatsForYear ==== | ==== getTaxonStatsForYear ==== | ||
| Line 324: | Line 323: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Occurrence / Specimen === | === Occurrence / Specimen === | ||
| Line 336: | Line 335: | ||
* ''spmInfo'': array of .. | * ''spmInfo'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getSpmsInfo ==== | ==== getSpmsInfo ==== | ||
| Line 347: | Line 346: | ||
* ''spmsInfo'': array of .. | * ''spmsInfo'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Locality === | === Locality === | ||
| Line 366: | Line 365: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&tnuid=30148&inst_id=1&per_id=1&pnid=1&showChildren=Y&completeSpmInfo=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Place / Geopolitical Entity === | === Place / Geopolitical Entity === | ||
| Line 378: | Line 377: | ||
* ''place_info'': array of .. (name, type, level, hier) | * ''place_info'': array of .. (name, type, level, hier) | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getSubdivisions ==== | ==== getSubdivisions ==== | ||
| Line 395: | Line 394: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getGeoTaxa ==== | ==== getGeoTaxa ==== | ||
| Line 409: | Line 408: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getGeoCollTrips ==== | ==== getGeoCollTrips ==== | ||
| Line 423: | Line 422: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getGeoCollTrips2 ==== | ==== getGeoCollTrips2 ==== | ||
| Line 437: | Line 436: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getGeoInsts ==== | ==== getGeoInsts ==== | ||
| Line 449: | Line 448: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Literature === | === Literature === | ||
| Line 463: | Line 462: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getLitParts ==== | ==== getLitParts ==== | ||
| Line 474: | Line 473: | ||
* ''pub_parts'': array of .. | * ''pub_parts'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLitParts?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getPubTaxonCitation ==== | ==== getPubTaxonCitation ==== | ||
| Line 487: | Line 486: | ||
* ''author'': string | * ''author'': string | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getPubAssocCitation ==== | ==== getPubAssocCitation ==== | ||
| Line 498: | Line 497: | ||
* ''assoc_cits'': array of .. | * ''assoc_cits'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Journal === | === Journal === | ||
| Line 519: | Line 518: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getJournalPubs ==== | ==== getJournalPubs ==== | ||
| Line 531: | Line 530: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getJournalTaxa ==== | ==== getJournalTaxa ==== | ||
| Line 542: | Line 541: | ||
* ''taxa'': array of taxon_basic | * ''taxa'': array of taxon_basic | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Institution === | === Institution === | ||
| Line 566: | Line 565: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getPrimaryTypes ==== | ==== getPrimaryTypes ==== | ||
| Line 582: | Line 581: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getSecondaryTypes ==== | ==== getSecondaryTypes ==== | ||
| Line 598: | Line 597: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getInstTaxa ==== | ==== getInstTaxa ==== | ||
| Line 611: | Line 610: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getInstCollTrips2 ==== | ==== getInstCollTrips2 ==== | ||
| Line 625: | Line 624: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getInstPubs ==== | ==== getInstPubs ==== | ||
| Line 636: | Line 635: | ||
* ''pubs'': array of literature_basic | * ''pubs'': array of literature_basic | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Unvouchered Record === | === Unvouchered Record === | ||
| Line 648: | Line 647: | ||
* ''unvoucheredRecord'': array of .. | * ''unvoucheredRecord'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getUnvoucheredRecords ==== | ==== getUnvoucheredRecords ==== | ||
| Line 661: | Line 660: | ||
* ''unvoucheredRecords'': array of .. | * ''unvoucheredRecords'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getUnvoucheredRecords ==== | ==== getUnvoucheredRecords ==== | ||
| Line 673: | Line 672: | ||
* | * | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecords?tnuid=44&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getUnvLocalityInfo ==== | ==== getUnvLocalityInfo ==== | ||
| Line 688: | Line 687: | ||
* ''locInfo'': array of .. | * ''locInfo'': array of .. | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvLocalityInfo?loc_id=1&tnuid=30148&per_id=1&pnid=1&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
=== Text Search === | === Text Search === | ||
| Line 707: | Line 706: | ||
* ''journal_results'': | * ''journal_results'': | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?name=Heptascelio+striatosternus&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getTaxaFromText ==== | ==== getTaxaFromText ==== | ||
| Line 721: | Line 720: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getCuidsFromText ==== | ==== getCuidsFromText ==== | ||
| Line 735: | Line 734: | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCuidsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getAgentsFromText ==== | ==== getAgentsFromText ==== | ||
| Line 749: | Line 748: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?name=Heptascelio+striatosternus&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getInstFromText ==== | ==== getInstFromText ==== | ||
| Line 762: | Line 761: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getInstFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getJournalsFromText ==== | ==== getJournalsFromText ==== | ||
| Line 775: | Line 774: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getOrgsFromText ==== | ==== getOrgsFromText ==== | ||
| Line 788: | Line 787: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getOrgsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getPlacesFromText ==== | ==== getPlacesFromText ==== | ||
| Line 801: | Line 800: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getLocalitiesFromText ==== | ==== getLocalitiesFromText ==== | ||
| Line 814: | Line 813: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
==== getCollMethodsFromText ==== | ==== getCollMethodsFromText ==== | ||
| Line 827: | Line 826: | ||
* ''count'': number | * ''count'': number | ||
===== Example ===== | ===== Example ===== | ||
| − | http://osuc.biosci.ohio-state.edu/ | + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCollMethodsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC |
| − | |||
| − | |||
== Data Type Glossary == | == Data Type Glossary == | ||
Revision as of 15:29, 19 June 2014
Introduction
OJ_Break is the name of the xBio:D RESTful(-like) API service to facilitate discovery of data within the xBio:D database. The API responds exclusively in JavaScript Object Notation (JSON) and accepts only HTTP GET and POST requests indiscriminately unlike a true REST API. Built using Oracle's PL/SQL database language, the API is fast but often inflexible and inconsistent, so take note of all of the comments below.
Contents
- 1 API Access
- 2 Procedural Reference
- 2.1 Taxon
- 2.1.1 getTaxonStats
- 2.1.2 getTaxonInfo
- 2.1.3 getTaxonHierarchy
- 2.1.4 getIncludedTaxa
- 2.1.5 getTaxonSynonyms
- 2.1.6 getLocalities
- 2.1.7 getLocalities
- 2.1.8 getCuids
- 2.1.9 getCuids
- 2.1.10 getTypes
- 2.1.11 getInsts
- 2.1.12 getTaxonLiterature (deprecated)
- 2.1.13 getTaxonLit
- 2.1.14 getAssociations
- 2.1.15 getHabitats
- 2.1.16 getTaxonMedia
- 2.1.17 getTaxonBreakdown
- 2.1.18 getTaxonPhenology
- 2.1.19 getTaxonNewTaxaByPub
- 2.1.20 getTaxonNewTaxaByYear
- 2.1.21 getTaxonStatsForYear
- 2.2 Occurrence / Specimen
- 2.3 Locality
- 2.4 Place / Geopolitical Entity
- 2.5 Literature
- 2.6 Journal
- 2.7 Institution
- 2.8 Unvouchered Record
- 2.9 Text Search
- 2.1 Taxon
- 3 Data Type Glossary
API Access
Using the OJ_Break 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: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
To read more about using the OJ_Break API, go to OJ_Break API Access.
Procedural Reference
Taxon
getTaxonStats
Description
Get some basic taxonomic statistics for a taxon from a tnuid.
Parameters
- tnuid: number
- callback: 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
- callback: 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
- callback: 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: string
- showFossils: string
- types_only: string
- show_num_spms: boolean_flag
- callback: string
Return
- tnuid: number
- parent_tnuid: number
- includedTaxa: array of taxon_extended
Example
getTaxonSynonyms
Description
Get the taxa that are objective or subjectively synonymous with a taxon.
Parameters
- tnuid: number
- showFossils: string
- callback: 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: string
- callback: 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: string
- callback: string
Return
- localities: array of loc_coords
Example
getCuids
Description
Get the occurrence identifiers (collecting unit IDs) for a taxon.
Parameters
- tnuid: number
- showChildren: string
- inst_id: number
- pnids: array of pnid
- callback: 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
- callback: string
Return
- cuids: array of cuid
Example
getTypes
Description
Parameters
- tnuid: number
- showSyns: string
- inst_id: number
- primary_only: string
- taxon_author_search: string
- offset: number
- limit: number
- callback: string
Return
- num_records: number
- types: array of taxon_basic and the below extensions
- valid_taxon: taxon_basic
- hier: taxon_hierarchy
- cuid: string
- inst_code: string
- inst_id: string
- type: string
- orig_desc: pubs
- images: media_basic
Example
getInsts
Description
Parameters
- tnuid: number
- callback: string
Return
- collections: array of collection (not yet added)
Example
getTaxonLiterature (deprecated)
Description
Deprecated. Use getTaxonLit instead
Parameters
- tnuid: number
- showSyns: string
- callback: string
Return
- lit: pubs
Example
getTaxonLit
Description
Preferred
Parameters
- tnuid: number
- showSyns: string
- callback: string
Return
- pubs: array of pubs
Example
getAssociations
Description
Parameters
- tnuid: number
- rank_grouping: string
- callback: string
Return
- associations: array of taxon_basic (tnuid is not a number) with the below extensions
- type: string
- relationship: string
- hier: taxon_hierarchy
- cuids: array of cuids
Example
getHabitats
Description
Parameters
- tnuid: number
- callback: string
Return
- habitats: array of media_basic with the below extensions
- habitat: string
Example
getTaxonMedia
Description
Parameters
- tnuid: number
- callback: string
Return
- media: array of media_basic
Example
getTaxonBreakdown
Description
Parameters
- tnuid: number
- callback: string
Return
- taxa: array of taxon_extended (tnuid is not a number)
- sex: array of spm_sex
Example
getTaxonPhenology
Description
Parameters
- tnuid: number
- callback: string
Return
- spms: array of the below elements
- date: string
- sort_date: string
- cuid: string
Example
getTaxonNewTaxaByPub
Description
Parameters
- tnuid: number
- validOnly: string
- callback: string
Return
- pubs: array of literature_basic with the below extension
- taxa_num: string
Example
getTaxonNewTaxaByYear
Description
Parameters
- tnuid: number
- validOnly: string
- callback: string
Return
- years: array of the below elements
- taxa_num: string
- year: string
Example
getTaxonStatsForYear
Description
Parameters
- tnuid: number
- stats_year: number
- callback: 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
getSpmInfo
Description
Parameters
- cuid: string
- callback: string
Return
- spmInfo: array of ..
Example
getSpmsInfo
Description
Parameters
- cuids: array of string
- callback: string
Return
- spmsInfo: array of ..
Example
Locality
getLocalityInfo
Description
Parameters
- loc_id: number
- tnuid: number
- inst_id: number
- per_id: number
- pnid: number
- showChildren: string
- completeSpmInfo: string
- callback: string
Return
- locInfo: array of loc_coords_extended
Example
Place / Geopolitical Entity
getPlaceInfo
Description
Parameters
- place_id: number
- callback: string
Return
- place_info: array of .. (name, type, level, hier)
Example
getSubdivisions
Description
Parameters
- place_id: number
- callback: string
Return
- subdivs: array of belowe elements
- pnid: number
- id: string
- name: string
- type: string
- level: number
Example
getGeoTaxa
Description
Parameters
- place_id: number
- callback: string
Return
- taxa: array of taxon_extended (tnuid is not a number) with the below extensions
- valid_taxon: taxon_basic
- hier: taxon_hierarchy
Example
getGeoCollTrips
Description
Parameters
- place_id: number
- callback: string
Return
- coll_trips: array of taxon_basic with below extensions
- institution class (not yet added)
- collector class (not yet added)
Example
getGeoCollTrips2
Description
Parameters
- place_id: number
- callback: string
Return
- coll_trips: array of taxon_basic with below extensions
- institution class (not yet added)
- collector class (not yet added)
Example
getGeoInsts
Description
Parameters
- place_id: number
- callback: string
Return
- collections: array of institution (not yet added)
Example
Literature
getLitReference
Description
Parameters
- pub_id: number
- callback: string
Return
- callback_opt1: string
- pub_ref: array of literature_basic (extended?)
Example
getLitParts
Description
Parameters
- pub_id: number
- callback: string
Return
- pub_parts: array of ..
Example
getPubTaxonCitation
Description
Parameters
- pub_id: number
- callback: string
Return
- pub_cits: array of ..
- public: string
- author: string
Example
getPubAssocCitation
Description
Parameters
- pub_id: number
- callback: string
Return
- assoc_cits: array of ..
Example
Journal
getJournalInfo
Description
Parameters
- jrnl_id: number
- callback: 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
- callback: string
Return
- pubs: array of literature_basic (extended?)
Example
getJournalTaxa
Description
Parameters
- jrnl_id: number
- callback: string
Return
- taxa: array of taxon_basic
Example
Institution
getCollectionInfo
Description
Parameters
- inst_id: number
- callback: string
Return
- collection_info: array of below elements
- name: string
- code: string
- vouchered: boolean (needs change to Y or N)
- num_prim_types: number
- num_sec_types: number
- num_species: number
- num_spms: number
- last_spm_time: string
- oldest_spm: array of the following
- cuid: string
- coll_date: string
Example
getPrimaryTypes
Description
Parameters
- inst_id: number
- callback: string
Return
- types: array of taxon_basic with below extensions
- cuid: string
- type: string
- hier: taxon_hierarchy
- orig_desc: pubs (not yet added)
Example
getSecondaryTypes
Description
Parameters
- inst_id: number
- callback: string
Return
- types: array of taxon_basic with below extensions
- cuid: string
- type: string
- hier: taxon_hierarchy
- orig_desc: pubs (not yet added)
Example
getInstTaxa
Description
Parameters
- inst_id: number
- callback: string
Return
- taxa: array of taxon_extended with below extension
- hier: taxon_hierarchy
Example
getInstCollTrips2
Description
Parameters
- inst_id: number
- callback: string
Return
- coll_trips: array of taxon_basic with below extensions
- institution class (not yet added)
- collector class (not yet added)
Example
getInstPubs
Description
Parameters
- inst_id: number
- callback: string
Return
- pubs: array of literature_basic
Example
Unvouchered Record
getUnvoucheredRecord
Description
Parameters
- unv_id: number
- callback: string
Return
- unvoucheredRecord: array of ..
Example
getUnvoucheredRecords
Description
Parameters
- tnuid: number
- showChildren: string
- pnids: array of number
- callback: string
Return
- unvoucheredRecords: array of ..
Example
getUnvoucheredRecords
Description
Parameters
- tnuid: number
- pnids: array of number
- callback: string
Return
Example
getUnvLocalityInfo
Description
Parameters
- loc_id: number
- tnuid: number
- per_id: number
- pnid: number
- showChildren: string
- callback: string
Return
- locInfo: array of ..
Example
Text Search
getSearchResults
Description
Parameters
- name: string
- limit: number
- categoryLimit: string
- callback: string
Return
- taxon_results:
- cuid_results:
- agent_results:
- inst_results:
- place_results:
- journal_results:
Example
getTaxaFromText
Description
Parameters
- name: string
- limit: number
- nameOnly: string
- callback: string
Return
- taxa:
- count: number
Example
getCuidsFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- cuids: array of cuid
- count: number
Example
getAgentsFromText
Description
Parameters
- name: string
- limit: number
- includeParty: string
- callback: string
Return
- agents:
- count: number
Example
getInstFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- inst:
- count: number
Example
getJournalsFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- journals:
- count: number
Example
getOrgsFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- orgs:
- count: number
Example
getPlacesFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- places:
- count: number
Example
getLocalitiesFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- locs:
- count: number
Example
getCollMethodsFromText
Description
Parameters
- name: string
- limit: number
- callback: string
Return
- coll_methods:
- count: number
