Worms Get Traits
worms_get_traitsRetrieve recorded attributes for an AphiaID or canonical WoRMS LSID, including inherited attributes by default. Resume nextResultOffset as resultOffset with unchanged selectors and options. Whole rows retain original preorder nodeIndex and parentIndex across pages; parents may be on earlier pages. measurementType keeps each matching node with its subtree and ancestors, indices unchanged; totalCount counts that set and unfilteredCount the whole tree. Values, references and inheritance markers remain unchanged; on an accepted taxon WoRMS also returns attributes recorded on its synonyms whatever includeInherited is set to, marked by inheritedFrom. A notice names the linked accepted ID, distinguishing an accepted alternative representation from its preferred ID. Missing traits do not prove biological absence; IUCN list membership is not a threat category.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aphiaId | Yes | Positive safe-integer AphiaID, decimal string, or canonical urn:lsid:marinespecies.org:taxname:<AphiaID>; outputs remain numeric. | |
| resultOffset | No | Zero-based local position; resubmit unchanged selectors and options. | |
| measurementType | No | Case-insensitive whole-value measurement type, not trimmed, e.g. Body size; blank means no filter. Names come from worms_list_reference with topic: trait_types. | |
| includeInherited | No | Include attributes inherited from higher taxa; default true. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echo | No | Effective options. | |
| error | No | Present when the call failed. Absent on success. | |
| notice | No | Linked accepted/preferred-AphiaID and absent-attribute guidance, in that order. | |
| traits | No | This preorder segment; indices refer to the complete original tree. | |
| aphiaId | No | Positive safe-integer AphiaID; obtain from worms_resolve_taxon. | |
| 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. | |
| 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. | |
| unfilteredCount | No | Nodes in the complete tree before the measurementType filter. | |
| nextResultOffset | No | Next local position; null when consumed. |