Skip to content

Documentation of the Species API endpoints #191

@khdlr

Description

@khdlr

Feedback on Species API (Github source for this page)

/v1/species/{usageKey}

The /v1/species/{usageKey} endpoint is documented as accepting an Accept-Language header:

Language for vernacular names, given as an ISO 639-1 two-letter code from our vocabulary.

Available values : abk, aar, afr, aka, sqi, amh, ara, arg, hye, asm, ava, ave, aym, aze, bam, bak, eus, bel, ben, bih, bis, bos, bre, bul, mya, cat, cha, che, zho, chu, chv, cor, cos, cre, hrv, ces, dan, div, nld, dzo, eng, epo, est, ewe, fao, fij, fin, fra, fry, ful, glg, lug, kat, deu, ell, kal, grn, guj, hat, hau, heb, her, hin, hmo, hun, isl, ido, ibo, ind, ina, ile, iku, ipk, gle, ita, jpn, jav, kan, kau, kas, kaz, khm, kik, kin, kir, kom, kon, kor, kur, kua, lao, lat, lav, lim, lin, lit, lub, ltz, mkd, mlg, msa, mal, mlt, glv, mri, mar, mah, mol, mon, nau, nav, ndo, nep, nde, sme, nob, nno, nor, nya, oci, oji, ori, orm, oss, pli, pan, fas, pol, por, pus, que, roh, ron, run, rus, smo, sag, san, srd, gla, srp, sna, iii, snd, sin, slk, slv, som, nbl, sot, spa, sun, swa, ssw, swe, tgl, tah, tgk, tam, tat, tel, tha, bod, tir, ton, tso, tsn, tur, tuk, twi, uig, ukr, urd, uzb, ven, vie, vol, wln, cym, wol, xho, yid, yor, zha, zul,
Example : en

The available values presented are, however, three-letter codes, and selecting any of them from the dropdown in the "Try it out" query will lead to the vernacular name being dropped from the response.

Meanwhile, correctly specifying a two-letter code (e.g. via cURL) works as expected.

/v1/species/{usageKey}/vernacularNames

Here, a JSON-encoded query object arg1 is strictly required. What does this query do? I was wondering if it was possible to filter the vernacular names by language, but couldn't find a way to do it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    API ReferenceIssues relating to enhancing the 'API Reference' section of the technical documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions