Worms Get Taxon
worms_get_taxonRetrieve full Aphia records by numeric IDs or canonical WoRMS LSIDs in byte-budgeted segments. Resume nextInputOffset as inputOffset using unchanged aphiaIds and options; inputIndex preserves duplicate and missing positions. includeVernaculars (common names) or includeSources (original description, basis of record, and other sources) requires one submitted ID, one of the two per call; resume nextVernacularOffset as vernacularOffset or nextSourceOffset as sourceOffset, repeating the full primary record. sourceUse filters whole use values ignoring case before sourceOffset; populated values are not trimmed. Successful source results report sourceTotalCount before slicing and unfilteredSourceCount only with an effective filter. Optional failure retains the record without source counts; unknown facts remain omitted or null.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aphiaIds | Yes | Nonempty original AphiaID list, with no total-input ceiling; at most 50 positions fetched per call. Resubmit unchanged with inputOffset, without deduplicating. | |
| sourceUse | No | Case-insensitive whole-value source use, such as original description; populated values are not trimmed, blanks omitted. Filters before sourceOffset; inactive without includeSources. | |
| inputOffset | No | Zero-based local position; resubmit unchanged selectors and options. | |
| sourceOffset | No | Zero-based position in the sourceUse-selected list for the singleton ID; repeat unchanged options. Inactive without includeSources. | |
| includeSources | No | Retrieve the taxon sources, such as its original description and basis of record; requires exactly one submitted ID and cannot combine with includeVernaculars. | |
| vernacularOffset | No | Zero-based common-name position for the singleton ID; repeat unchanged options. Inactive without includeVernaculars. | |
| includeVernaculars | No | Retrieve common names; requires exactly one submitted ID. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echo | No | Effective options. | |
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Guidance for deferred work. | |
| results | No | One positional result per processed ID. | |
| byteBudget | No | Complete serialized response byte target. | |
| attribution | No | WoRMS source attribution. | |
| budgetLimited | No | Whether the byte budget ended this local page early. | |
| deferredCount | No | Number of original ID positions still deferred. | |
| 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. | |
| nextInputOffset | No | Resume position in the unchanged original aphiaIds; null when consumed. | |
| nextSourceOffset | No | Resume sources for the same singleton record; null when consumed or not requested. | |
| nextVernacularOffset | No | Resume common names for the same singleton record; null when consumed or not requested. |