Web Services API for accessing CoL Checklist from a CDM Data Source¶

This wiki page describes the Web Service API which implements the specifications as mentioned here

• Table of contents
• Web Services API for accessing CoL Checklist from a CDM Data Source
  • General
  • To Do
    • Pager
  • Notes
    • JSON Default
  • Name String Search
    • Examples
    • To Do
    • Notes
  • Name Information
    • Examples
    • To Do
    • Notes
  • Taxon Information
    • Examples
    • To Do
    • Notes

General¶

This section deals with general issues regarding the API Development

To Do¶

Pager¶

The pager implementation for all specified services are yet to be developed.

Notes¶

JSON Default¶

Even though the specification mentions JSON as the default view, the usual REST service request url practice is to include 'application/json' in the request 'Accept' header or set json as response type in the request url itself (e.g. http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba%20Mill.)

Name String Search¶

Examples¶

• Exact Name Search : http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba%20Mill.

• Wildcard Name Search (Match Anywhere) : http://160.45.63.201:8080/col/name_catalogue.json?query=*esculenta*

• Wildcard Name Search (Match Beginning): http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba*

• Wildcard Name Search (Match End) :

• Multiple Name Search Queries : http://160.45.63.201:8080/col/name_catalogue.json?query=Acacia%20esculenta%20DC.&query=Abies%20alba%20Mill.

To Do¶

Notes¶

• Could be interesting to add a list of name lsids in the response.

Name Information¶

Examples¶

• Single Query : http://160.45.63.201:8080/col/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf

• Multiple Query : http://160.45.63.201:8080/col/name_catalogue/name.json?nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57&nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf

To Do¶

Notes¶

Taxon Information¶

Examples¶

• Single Query (Accepted Name) : http://160.45.63.201:8080/col/name_catalogue/taxon.json?taxonUuid=0fd48e3d-c6dc-44f5-aa47-ae294b6716eb

• Single Query (Synonym) : http://160.45.63.201:8080/col/name_catalogue/taxon.json?taxonUuid=425e45f5-c7ef-4b19-8245-5b642e91d74b

• Multiple Query : http://160.45.63.201:8080/col/name_catalogue/taxon.json?taxonUuid=425e45f5-c7ef-4b19-8245-5b642e91d74b&taxonUuid=1c218146-954b-4458-a41b-6d7518e96898

To Do¶

Notes¶