CoL2EDITWSAPI » History » Version 14
Cherian Mathew, 04/26/2012 01:17 PM
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 | 6 | Cherian Mathew | ### JSON Default |
28 | 5 | Cherian Mathew | |
29 | 11 | Cherian Mathew | 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 | 5 | Cherian Mathew | |
31 | |||
32 | |||
33 | 1 | Cherian Mathew | ## Name String Search |
34 | 6 | Cherian Mathew | |
35 | |||
36 | ### Examples |
||
37 | |||
38 | * Exact Name Search : http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba%20Mill. |
||
39 | |||
40 | 12 | Cherian Mathew | * Wildcard Name Search (Match Anywhere) : http://160.45.63.201:8080/col/name_catalogue.json?query=*esculenta* |
41 | 6 | Cherian Mathew | |
42 | 12 | Cherian Mathew | * Wildcard Name Search (Match Beginning): http://160.45.63.201:8080/col/name_catalogue.json?query=Abies%20alba* |
43 | 6 | Cherian Mathew | |
44 | 12 | Cherian Mathew | * Wildcard Name Search (Match End) : |
45 | 6 | Cherian Mathew | |
46 | 7 | Cherian Mathew | * Multiple Name Search Queries : http://160.45.63.201:8080/col/name_catalogue.json?query=Acacia%20esculenta%20DC.&query=Abies%20alba%20Mill. |
47 | |||
48 | 6 | Cherian Mathew | |
49 | ### To Do |
||
50 | |||
51 | |||
52 | ### Notes |
||
53 | |||
54 | 13 | Cherian Mathew | * Could be interesting to add a list of name lsids in the response. |
55 | 6 | Cherian Mathew | |
56 | |||
57 | |||
58 | ## Name Information |
||
59 | 2 | Cherian Mathew | |
60 | 4 | Cherian Mathew | |
61 | 1 | Cherian Mathew | ### Examples |
62 | |||
63 | 8 | Cherian Mathew | * Single Query : http://160.45.63.201:8080/col/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf |
64 | 4 | Cherian Mathew | |
65 | 8 | Cherian Mathew | * 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 |
66 | 1 | Cherian Mathew | |
67 | |||
68 | 8 | Cherian Mathew | ### To Do |
69 | 1 | Cherian Mathew | |
70 | |||
71 | 8 | Cherian Mathew | ### Notes |
72 | |||
73 | 14 | Cherian Mathew | * At the moment taxon lsids are not included in 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 ? |
74 | 8 | Cherian Mathew | |
75 | |||
76 | 14 | Cherian Mathew | |
77 | 8 | Cherian Mathew | ## Taxon Information |
78 | |||
79 | |||
80 | ### Examples |
||
81 | |||
82 | 9 | Cherian Mathew | * Single Query (Accepted Name) : http://160.45.63.201:8080/col/name_catalogue/taxon.json?taxonUuid=0fd48e3d-c6dc-44f5-aa47-ae294b6716eb |
83 | 1 | Cherian Mathew | |
84 | 9 | Cherian Mathew | * Single Query (Synonym) : http://160.45.63.201:8080/col/name_catalogue/taxon.json?taxonUuid=425e45f5-c7ef-4b19-8245-5b642e91d74b |
85 | |||
86 | * 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 |
||
87 | 8 | Cherian Mathew | |
88 | |||
89 | 5 | Cherian Mathew | ### To Do |
90 | |||
91 | |||
92 | ### Notes |
||
93 | 14 | Cherian Mathew | |
94 | * 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 ? |
||
95 | |||
96 | * 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 ? |