Worms Resolve Taxon
worms_resolve_taxonResolve exact or explicitly fuzzy scientific names, or search one vernacular name as a whole recorded common name or, with vernacularMatch: "contains", as part of one. Names default to marine and extant taxa; vernacular cannot filter. Resume scientific segments with nextInputOffset and nextMatchOffset against unchanged names and options; inputIndex preserves duplicates and partialGroup identifies split groups. For vernacular, consume nextResultOffset within the same upstream offset before advancing page.nextOffset and resetting resultOffset to zero. Full 50-match upstream groups remain completeness-unknown; accepted-name fields do not choose an ambiguous match.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fuzzy | No | Explicit fuzzy scientific-name matching; unavailable for vernacular. | |
| names | No | Nonempty original scientific-name list, with no total-input ceiling; at most 50 positions fetched per call. Resubmit unchanged with continuation offsets, preserving duplicates. | |
| offset | No | Vernacular only: one-based upstream starting record, advancing by 50; default 1. Scientific names accept only 1. | |
| extantOnly | No | Filter scientific names to extant taxa; vernacular cannot filter and rejects false. | |
| marineOnly | No | Filter scientific names to marine taxa; vernacular cannot filter and rejects false. | |
| vernacular | No | Common name, mutually exclusive with names; blank means unset. | |
| inputOffset | No | Zero-based original scientific names position; inactive for vernacular. | |
| matchOffset | No | Zero-based match within the scientific-name group at inputOffset; inactive for vernacular. | |
| resultOffset | No | Zero-based match within the fetched vernacular page; keep upstream offset until consumed. Inactive for scientific names. | |
| vernacularMatch | No | Vernacular only: exact matches a whole recorded common name; contains matches every recorded common name containing the text, such as grouper in Nassau grouper. Names accept only exact; blank means exact. | exact |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echo | No | Effective matching options. | |
| mode | No | Matching mode. | |
| page | No | Vernacular page only. | |
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Empty vernacular-page guidance, or the inputIndex of each returned 50-match scientific-name group, whose completeness is unknown, with the change that narrows it. | |
| results | No | One result per processed input. | |
| byteBudget | No | Complete serialized response byte target. | |
| totalCount | No | Known local sequence length before pagination. | |
| attribution | No | WoRMS source attribution. | |
| resultOffset | No | Zero-based starting position in the complete local sequence. | |
| budgetLimited | No | Whether the byte budget ended this local page early. | |
| deferredCount | No | Original input positions not fully consumed. | |
| oversizedItem | No | One indivisible scientific item exceeds the target; retained intact with forward progress. | |
| requiredBytes | No | Serialized paired-surface result bytes for an oversized item, excluding transport-added metadata. | |
| returnedCount | No | Whole scientific items returned on this segment. | |
| nextInputOffset | No | Next original names position; resubmit unchanged names and options. | |
| nextMatchOffset | No | Next match position at nextInputOffset; null when names consumed. | |
| nextResultOffset | No | Next local position; null when consumed. |