Worms List Reference
worms_list_referenceList supported external identifier systems, a non-exhaustive taxonomic-status guide grouped as accepted, unaccepted, uncertain, or technical, environment-flag semantics, observed worms_get_distributions filter values, live taxonomic ranks, or live trait definitions. Resume nextResultOffset as resultOffset with the same topic. Identifier codes, statuses, environment flags, and distribution terms are available offline. A record status can be the specific reason itself, such as junior subjective synonym, rather than unaccepted. IUCN identifiers are not threat categories; null flags mean not recorded. Trait definitions retain complete-tree preorder indices across pages; parents may be on earlier pages.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | Reference topic: external_id_types, statuses, environment_flags, distribution_terms, ranks, or trait_types. | |
| resultOffset | No | Zero-based local position; resubmit unchanged selectors and options. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present when the call failed. Absent on success. | |
| topic | No | Requested reference topic. | |
| notice | No | Guidance for empty live references. | |
| entries | No | Whole reference entries in this segment with topic-specific fields. | |
| 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. | |
| 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. |