|
|
|
AGROVOC Web Services Version 2.0 (beta)
AGROVOC is accessible via web services, which can be called from any client application. The web services are realized on Apache Axis running on Tomcat. They are invoked via standard SOAP calls, returning a standard SOAP response. For more information on the used technology see the downloads and links sections below.
Results in XML format
All AGROVOC web services are now available as XML version. The webservices basically return the same values as before (with slight adjustments), however, now there is an additional format parameter for each webservice, in which the requester specifies the format of the result string (TBX, SKOS, OWL, etc.). In this beta release, we implemented only TBX output. Other formats will follow soon. Please test the new services and provide us with your feedback. If you detect any errors or have suggestions for modelling the XML result, please write to us FAO-AGRIS-CARIS@fao.org. If you like to learn more about the TBX standard, please refer to the official web site
Please register!
As a user of AGROVOC web services, please register with us in order to receive full support for updates and receive important notifications regarding the service. You can do so by sending a blank email with the subject 'AGROVOC Web Services Email List Registration' to FAO-AGRIS-CARIS@fao.org.
Available web services
Click on any of the following web services to try them out online!
(You can download the full description of the web services in the download section below)
| Name of Web Service |
Description |
| getTermcodeByTerm |
Returns the termcode of an existing AGROVOC term. |
| getTermByLanguage |
Returns an AGROVOC term specified by its termcode and language. |
| getTermsListByLanguage |
Returns a list of AGROVOC terms specified by their termcode and language. |
| getAllLabelsByTermcode |
Returns all labels of a term matching the specified termcode. |
| searchByTerm |
Returns all AGROVOC terms containing the specified search string. |
| simpleSearchByMode |
Returns all AGROVOC terms containing the specified search string in the specified search mode. |
getConceptByTerm
deprecated |
Returns the concept, i.e. labels, broader terms, narrower terms, related terms matching a term. |
| getConceptInfoByTermcode |
Returns the concept, i.e. labels, broader terms, narrower terms, related terms, use and used for information matching a term's termcode. |
| getDefinitions |
Returns a terms definitions, history or scope notes. |
| getTermExpansion |
Returns all synonyms of an AGROVOC term (related terms with the UF relationship) in form of an extended search query. This service is inteded to be used in search engines for query expansion. Refer to the Web Services documentation below for the details of use. |
|
getTermcodeByTermXML
(beta) |
Returns the termcode of an existing AGROVOC term in XML format. |
|
getTermByLanguageXML
(beta) |
Returns an AGROVOC term specified by its termcode and language in XML format. Indicates, if it is a descriptor (termType = entryTerm) or a non-descriptor (termType = synonym). |
|
getTermsListByLanguageXML
(beta) |
Returns a list of AGROVOC terms specified by their termcode and language in XML format. |
|
getAllLabelsByTermcodeXML
(beta) |
Returns all labels of a term matching the specified termcode in XML format. |
|
searchByTermXML
(beta) |
Returns all AGROVOC terms containing the specified search string in XML format. |
|
simpleSearchByModeXML
(beta) |
Returns all AGROVOC terms containing the specified search string in the specified search mode in XML format. |
|
getConceptInfoByTermcodeXML
(beta) |
Returns the most important concept information matching a term's termcode, i.e. labels, broader terms, narrower terms, related terms and synonyms (use, used for) in XML format. |
|
getDefinitionsXML
(beta) |
Returns a terms definitions, history or scope notes or term codes in XML format. |
Downloads
| Item |
Description |
HTML |
Download |
| WSDL |
WSDL description of the web services |
xml file |
- |
| Web Services Documentation |
Detailed documentation of the available web services |
- |
word doc (56KB) |
| Test Client |
A simple JSP based test client web application. It can be easily installed in Tomcat |
- |
zip file (1.62MB) |
| Test Client documentation |
Installation guide for the testclient. It explains the structure and files of the client application and contains further links |
- |
word doc (56KB) |
Links
::Tools and Tutorials
::Other web services
|
|
|
print-friendly version