Worms Get Synonyms
worms_get_synonymsRetrieve synonyms for the accepted taxon linked from an AphiaID obtained with worms_resolve_taxon. Consume nextResultOffset within the same upstream offset before advancing page.nextOffset and resetting resultOffset to zero. A present name without an accepted ID has no synonym lookup; inspect it with worms_get_taxon. A full fetched 50-row page has uncertain continuation and may lead to an empty page.
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. | |
| resultOffset | No | Zero-based local position; resubmit unchanged selectors and options. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| echo | No | Effective pagination. | |
| page | No | Pagination only when synonym retrieval occurred. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | Whether the supplied taxon exists. | |
| notice | No | Guidance for an empty synonym page past the first. | |
| aphiaId | No | Positive safe-integer AphiaID; obtain from worms_resolve_taxon. | |
| guidance | No | Next step when no accepted taxon is known. | |
| synonyms | No | Whole synonym rows in this byte-budgeted segment. | |
| 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. | |
| validAphiaId | No | Accepted taxon ID when known. | |
| 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. |