Screen a species list against the species registers held, in one call

Up to 500 names, each answered by find_designations itself: its designations with their cites and the registers searched that are silent on it with what each one's silence means, or its own coded refusal (designations.none_held = no register searched names it, a statement about these registers and never that the species is unprotected; species.ambiguous with candidates; species.unreadable). A register's instrument, title, edition, place, note for the place, source URL and sha256 are sent once, in registers: a designation, its cite or a silent entry leaves out a field only where its value is the register's. A designation without outcome_says says outcomes[outcome]; a reconciled name without source is read from backbone. summary counts the names listed, listed only under a population or subspecies, watch-listed, named but listed by none, named by no register, ambiguous and refused, and how many names each register lists. Use it instead of one call a name: the door allows 30 calls in 10 seconds.

post/designations

Request

  • Base URL: https://passage-data.com/api/v1
  • URL: https://passage-data.com/api/v1/designations
  • Auth: one of:
    • none
    • HTTP bearer
    • API key in header x-api-key

Request body

speciesstring[] required

The names as the list prints them: scientific names (authorship allowed) or common names exactly as a register prints them.

placestring

ISO 3166 code of where the species are: US, CA, GB, FR, US-CA, CA-ON, GB-SCT. Omit to search every register.

Response

One result a name, in the list's order, beside the registers they name and a summary; or the call refused once (place.malformed)

queryobject
searchedobject
packed_asstring
registersobject
outcomesobject
backboneobject
refusedobject

Changes

No recorded changes to this operation across all 1 revision of this API.