EDIT

# 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](http://dev.e-taxonomy.eu/trac/wiki/CoL2EDITWebServices.)*

----

{{toc}}

{{child_pages(depth=1)}}

## General

This section deals with general issues regarding the API Development

### Status

06/04/2012 : First version of CoL-CDM services installed on [[EDIT|Production Server http://dev.e-taxonomy.eu/cdmserver/col/]]

## To Do

### Pager

The [pager](http://dev.e-taxonomy.eu/trac/wiki/CoL2EDITWebServices#Paging) 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://dev.e-taxonomy.eu/cdmserver/col/name_catalogue.json?query=Abies%20alba)

## Name String Search

### Examples

* Exact Name Search                     : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue.json?query=Abies%20alba

* Wildcard Name Search (Match Anywhere) : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue.json?query=*esculenta*

* Wildcard Name Search (Match Beginning): http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue.json?query=Abies%20alba*

* Wildcard Name Search (Match End)      : 

* Multiple Name Search Queries          : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue.json?query=Acacia%20esculenta&query=Abies%20alba

### To Do

### Notes

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

## Name Information

### Examples

* Single Query                          : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf

* Multiple Query                        : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue/name.json?nameUuid=0d5e07b6-2646-4210-80e0-fcd449e26b57&nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf

### To Do

### Notes

* At the moment taxon lsids are not included in the response in the case where the name uuid corresponds to a synonym. Would it be interesting to return taxon lsids of the accepted taxa (could be more than one) of this synonym ?

## Taxon Information

### Examples

* Single Query (Accepted Name)          : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue/taxon.json?taxonUuid=0fd48e3d-c6dc-44f5-aa47-ae294b6716eb

* Single Query (Synonym)                : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue/taxon.json?taxonUuid=425e45f5-c7ef-4b19-8245-5b642e91d74b

* Multiple Query                        : http://dev.e-taxonomy.eu/cdmserver/col/name_catalogue/taxon.json?taxonUuid=425e45f5-c7ef-4b19-8245-5b642e91d74b&taxonUuid=1c218146-954b-4458-a41b-6d7518e96898

### To Do

### Notes

* At the moment, the classification map is not included when the taxon uuid corresponds to a synonym. Would it be correct to return classification maps of the accepted taxa (could be more than one) of this synonym ?

* At the moment, for synonyms, only the list of accepted taxa are included in related taxa field in the response. Would it be interesting to include even the synonyms of these accepted taxa ?