Worms Crosswalk Id
worms_crosswalk_idCrosswalk an AphiaID from worms_resolve_taxon to one or all nine external identifier systems, or reverse an externalId with required type to a full taxon record. Supply exactly one selector. Forward resultOffset indexes whole identifiers across types in requested order; resume nextResultOffset with unchanged selectors. typeTotals distinguishes successful absence from IDs on another segment; failed types remain separate. IDs stay opaque, including leading zeros and LSIDs. No IDs cannot establish taxon absence; IUCN identifiers are not threat categories.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "worms_crosswalk_id"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | Required for reverse; omit forward to query all nine types. Codes ignore case and surrounding whitespace. See worms_list_reference external_id_types. | |
| aphiaId | No | Forward numeric AphiaID, decimal string, or canonical WoRMS LSID; mutually exclusive with externalId. | |
| externalId | No | Reverse selector; opaque identifier up to 512 characters; blank omitted. | |
| resultOffset | No | Zero-based forward identifier position across types in requested order; repeat unchanged selectors. Inactive for reverse lookup. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | This segment of answered types; consult typeTotals to distinguish empty evidence from IDs on another segment. | |
| echo | No | Effective crosswalk selectors. | |
| type | No | Explicitly selected identifier system. | |
| error | No | Present when the call failed. Absent on success. | |
| found | No | Reverse match state; null in forward mode. | |
| notice | No | Partial-outage retry guidance. | |
| record | No | Reverse matched record only. | |
| aphiaId | No | Supplied or matched taxon ID; null for reverse misses. | |
| guidance | No | Guidance when no identifiers or reverse match are found. | |
| direction | No | Selected crosswalk direction. | |
| byteBudget | No | Complete serialized response byte target. | |
| externalId | No | Opaque reverse identifier, preserved as text. | |
| totalCount | No | Known local sequence length before pagination. | |
| typeTotals | No | Answered types only; zero means successful absence; failed types are omitted. | |
| attribution | No | WoRMS source attribution. | |
| failedTypes | No | Failed types in fixed vocabulary order. | |
| 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. |