Project

General

Profile

CoL2EDITWSAPI » History » Version 5

Cherian Mathew, 04/26/2012 10:24 AM

1 1 Cherian Mathew
2
# Web Services API for accessing CoL Checklist from a CDM Data Source
3
4
This wiki page describes the Web Service API which implements the specifications as mentioned [here](http://dev.e-taxonomy.eu/trac/wiki/CoL2EDITWebServices.)
5
6
7
{{>toc}}
8
9
10
11
## General
12
13
This section deals with general issues regarding the API Development
14
15
16 2 Cherian Mathew
## To Do
17 1 Cherian Mathew
18
19
### Pager
20
21 5 Cherian Mathew
The [pager](http://dev.e-taxonomy.eu/trac/wiki/CoL2EDITWebServices#Paging) implementation for all specified services are yet to be developed.
22 1 Cherian Mathew
23
24 5 Cherian Mathew
## Notes
25 1 Cherian Mathew
26 5 Cherian Mathew
27
## JSON Default
28
29
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.)
30
31
32
33 2 Cherian Mathew
## Name String Search
34
35 4 Cherian Mathew
36 1 Cherian Mathew
### Examples
37
38 5 Cherian Mathew
* Exact Name Search                     : http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba%20Mill.
39 4 Cherian Mathew
40 5 Cherian Mathew
* Wildcard Name Search (Match Anywhere) : http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba*
41 1 Cherian Mathew
42
* Wildcard Name Search (Match Beginning): 
43
44 5 Cherian Mathew
* Wildcard Name Search (Match End)      : http://160.45.63.201:8080/col/name_catalogue.json?query=*esculenta*
45
46
47
### To Do
48
49
50
### Notes
51
52
* Could be interesting to add a list of names lsids in the reponse.