cdmlib / src / site / apt / remote / name-catalogue-accepted.apt @ ced1ade2
History | View | Annotate | Download (2.77 KB)
1 |
------------------------ |
---|---|
2 |
Accepted Name Search API |
3 |
------------------------ |
4 |
|
5 |
{CDM Taxonomic Accepted Name Search API} |
6 |
|
7 |
This web service endpoint serves as a search engine for retrieving taxonomic information of the accepted name of the synonomy to which the queried scientific name belongs. |
8 |
In case of homonyms, this service will return a list. Misapplied names are not considered in this service. |
9 |
|
10 |
The request parameters are : |
11 |
|
12 |
* '<<query>>' [mandatory] : this could either be the base scientific name or the complete scientific name. |
13 |
|
14 |
* '<<type>>' [optional, default value = <<<name>>>] : this parameter could have the values, |
15 |
|
16 |
* <<<name>>> : to be used in the case of scientific names without authorship strings other other markers (e.g. Abies alba). |
17 |
|
18 |
* <<<title>>> : to be used in the case of scientific names with authorship strings and other markers (e.g. Abies alba Mill.). |
19 |
|
20 |
[] |
21 |
|
22 |
The response format can be set by appending the format extension to the service endpoint. Currently this web service supports JSON (fully implemented) and XML (partially implemented). |
23 |
|
24 |
The response objects returned by this web service endpoint have the following structure: |
25 |
|
26 |
* <<<request>>> |
27 |
|
28 |
* <<<query>>> : scientific name provided as input. |
29 |
|
30 |
* <<<response>>> |
31 |
|
32 |
* <<<acceptedName>>> : accepted name of the synonomy to which the queried scientific name belongs. |
33 |
|
34 |
* <<<authorship>>> : authorship of the accepted name. |
35 |
|
36 |
* <<<classification>>> : classification of the requested taxon. |
37 |
|
38 |
* <<<rank>>> : taxonomic rank of the accepted name. |
39 |
|
40 |
Features: |
41 |
|
42 |
* Possibility to perform multiple queries in one single web service call. |
43 |
|
44 |
* Standardised and structured error messages. |
45 |
|
46 |
Example Requests : |
47 |
|
48 |
* Base scientific name search : |
49 |
|
50 |
* {{{queryTara_spinosa} /name_catalogue.json?query=Tara spinosa}} |
51 |
|
52 |
Example Responses : |
53 |
|
54 |
* Base scientific name search : {query=Tara spinosa} [{{{CDM_Taxonomic_Accepted_Name_Search_API}back}}] |
55 |
|
56 |
--- |
57 |
[ |
58 |
|
59 |
{ |
60 |
"request": { |
61 |
"query": "Tara spinosa" |
62 |
}, |
63 |
"response": [ |
64 |
{ |
65 |
"acceptedName": "Caesalpinia spinosa", |
66 |
"authorship": "(Molina) untze", |
67 |
"classification": { |
68 |
"Kingdom": "Plantae", |
69 |
"Phylum": "Magnoliophyta", |
70 |
"Class": "Magnoliopsida", |
71 |
"Order": "Fabales", |
72 |
"Family": "Fabaceae", |
73 |
"Genus": "Caesalpinia", |
74 |
"Species": "Caesalpinia spinosa (Molina) untze" |
75 |
}, |
76 |
"rank": "Species" |
77 |
} |
78 |
] |
79 |
} |
80 |
|
81 |
] |
82 |
|
83 |
--- |
84 |
|