Worms Get Classification
worms_get_classificationRetrieve root-to-tip classification and optional direct children for an AphiaID or canonical WoRMS LSID. resultOffset indexes lineage followed by fetched children; consume nextResultOffset with unchanged options and upstream offset before advancing page.nextOffset and resetting resultOffset to zero. Missing ranks remain unknown; child offset and filters are inactive without includeChildren. A full fetched 50-row child page has uncertain continuation and can lead to an empty page. The submitted ID keeps its own recorded lineage; a notice names its linked accepted ID, distinguishing an accepted alternative representation from its preferred ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | One-based starting record, advancing by 50; default 1. | |
| aphiaId | Yes | Positive safe-integer AphiaID, decimal string, or canonical urn:lsid:marinespecies.org:taxname:<AphiaID>; outputs remain numeric. | |
| extantOnly | No | Extant children only; inactive without includeChildren. | |
| marineOnly | No | Marine children only; inactive without includeChildren. | |
| resultOffset | No | Zero-based position in lineage followed by fetched children; keep upstream offset unchanged until nextResultOffset is null. | |
| includeChildren | No | Also fetch one page of direct children. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echo | No | Effective options; child-only options inactive when includeChildren is false. | |
| page | No | Children pagination only. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | Whether classification exists. | |
| ranks | No | This segment of the root-to-tip lineage. | |
| notice | No | Linked accepted/preferred-AphiaID and empty-children-page guidance, in that order. | |
| aphiaId | No | Positive safe-integer AphiaID; obtain from worms_resolve_taxon. | |
| children | No | One page of direct children when requested and retrieved. | |
| guidance | No | Next step for absent classification. | |
| byteBudget | No | Complete serialized response byte target. | |
| totalCount | No | Known local sequence length before pagination. | |
| attribution | No | WoRMS source attribution. | |
| statusError | No | Failed taxonomic-status read; evidence is unaffected, but whether the AphiaID is its accepted name is unknown. | |
| resultOffset | No | Zero-based starting position in the complete local sequence. | |
| budgetLimited | No | Whether the byte budget ended this local page early. | |
| childrenError | No | Optional children retrieval failure. | |
| 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. | |
| nextResultOffset | No | Next local position; null when consumed. |