Species

Root name usages of a dataset

Retrieves root name usages for a checklist dataset.

get/v1/species/root/{datasetKey}

Path parameters

datasetKeystring uuid required

A UUID of a checklist dataset.

Query parameters

offsetinteger

limitinteger

Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.

offsetinteger

Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.

Headers

Accept-Language'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' | ''

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

Response

Root name usages found

offsetinteger

The offset of the results within all the search results.

Subsequent pages can be retrieved by using offset + count as the new offset.

limitinteger

The limit used. Note the limit returned may be lower than the limit requested.

endOfRecordsboolean

True if this page of search results is the final page.

countinteger

The total number of records returned by the search.

Changes

Changed in 1 of the 2 revisions of this API.112

Aug 20, 202603ccf35f8dd9112See the full diff
- ▲
  added the new required query request parameter arg1
  new-required-request-parameter
- ▲
  the response property results/items/datasetKey became optional for the status 200 (media type: application/json)
  response-property-became-optional
- ▲
  the response property results/items/datasetKey became optional for the status 200 (media type: application/x-javascript)
  response-property-became-optional
- ▲
  the response property results/items/issues became optional for the status 200 (media type: application/json)
  response-property-became-optional
- ▲
  the response property results/items/issues became optional for the status 200 (media type: application/x-javascript)
  response-property-became-optional
- ▲
  the response property results/items/key became optional for the status 200 (media type: application/json)
  response-property-became-optional
- ▲
  the response property results/items/key became optional for the status 200 (media type: application/x-javascript)
  response-property-became-optional
- ▲
  the response property results/items/origin became optional for the status 200 (media type: application/json)
  response-property-became-optional
- ▲
  the response property results/items/origin became optional for the status 200 (media type: application/x-javascript)
  response-property-became-optional
- ▲
  the response property results/items/scientificName became optional for the status 200 (media type: application/json)
  response-property-became-optional
- ▲
  the response property results/items/scientificName became optional for the status 200 (media type: application/x-javascript)
  response-property-became-optional
- ●
  for the query request parameter limit, the min was set to 0.00
  request-parameter-min-set
- ●
  for the query request parameter offset, the min was set to 0.00
  request-parameter-min-set

Full history