Project

General

Profile

Edit History

WikiStart » Projects » CoL Import Dokumentation »

CoL2EDITWSAPI » History » Version 9

Cherian Mathew, 04/26/2012 10:42 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
    6
    Cherian Mathew
    
### JSON Default





    28
    
    
    
=





    29
    5
    Cherian Mathew
    





    30
    
    
    
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.)





    31
    
    
    





    32
    
    
    





    33
    
    
    





    34
    1
    Cherian Mathew
    
## Name String Search





    35
    6
    Cherian Mathew
    





    36
    
    
    





    37
    
    
    
### Examples





    38
    
    
    





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





    40
    
    
    





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





    42
    
    
    





    43
    
    
    
* Wildcard Name Search (Match Beginning): 





    44
    
    
    





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





    46
    
    
    





    47
    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.





    48
    
    
    





    49
    6
    Cherian Mathew
    





    50
    
    
    
### To Do





    51
    
    
    





    52
    
    
    





    53
    
    
    
### Notes





    54
    
    
    





    55
    
    
    
* Could be interesting to add a list of names lsids in the reponse.





    56
    
    
    





    57
    
    
    





    58
    
    
    





    59
    
    
    
## Name Information





    60
    2
    Cherian Mathew
    





    61
    4
    Cherian Mathew
    





    62
    1
    Cherian Mathew
    
### Examples





    63
    
    
    





    64
    8
    Cherian Mathew
    
* Single Query                          : http://160.45.63.201:8080/col/name_catalogue/name.json?nameUuid=cd4bc51f-ddcd-4e9c-aa02-4301fd78debf





    65
    4
    Cherian Mathew
    





    66
    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





    67
    1
    Cherian Mathew
    





    68
    
    
    





    69
    8
    Cherian Mathew
    
### To Do





    70
    1
    Cherian Mathew
    





    71
    
    
    





    72
    8
    Cherian Mathew
    
### Notes





    73
    
    
    





    74
    
    
    





    75
    
    
    





    76
    
    
    
## Taxon Information





    77
    
    
    





    78
    
    
    





    79
    
    
    
### Examples





    80
    
    
    





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





    82
    1
    Cherian Mathew
    





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





    84
    
    
    





    85
    
    
    
* 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





    86
    8
    Cherian Mathew
    





    87
    
    
    





    88
    5
    Cherian Mathew
    
### To Do





    89
    
    
    





    90
    
    
    





    91
    
    
    
### Notes