FAO Home


Documentation

 Web Services Documentation

Detailed documentation on the available web services  word doc (56KB)

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)

Name of Web Service Description
getAgrovocLanguages
Returns all the languages in which AGROVOC is currently available.
getTermcodeByTerm
getTermcodeByTermXML
Returns the termcode of an existing AGROVOC term.
getTermByLanguage
getTermByLanguageXML
Returns an AGROVOC term specified by its termcode and language. The XML version indicates, if it is a descriptor (termType = entryTerm) or a non-descriptor (termType = synonym).
getTermsListByLanguage2
getTermsListByLanguageXML
Returns a list of AGROVOC terms specified by their termcode and language.
getAllLabelsByTermcode2
getAllLabelsByTermcodeXML
Returns all labels of a term matching the specified termcode.
simpleSearchByMode2
simpleSearchByModeXML
Returns all AGROVOC terms containing the specified search string in the specified search mode.
searchByTerm2
searchByTermXML
Returns all AGROVOC terms containing the specified search string.
searchCategoryByMode
searchCategoryByModeXML
Returns all categories of a specified scheme containing the specified search string.

simpleSearchByModeandLang

Returns all AGROVOC terms containing the specified search string in the specified search mode and language.

simpleSearchByModeLangXML

Returns the output either SKOS or TBX format containing the specified search string in the specified search mode and language.
getStatus Returns the status, either descriptor or nondescriptor of an existing AGROVOC term.
getRelationByTermcodeXML Returns the output in the SKOS or TXT format based on specific relations of an existing AGROVOC term.
getConceptInfoByTermcode
getConceptInfoByTermcodeXML
Returns the concept, i.e. labels, broader terms, narrower terms, related terms, use and used for information matching a term's termcode.
getDefinitions
getDefinitionsXML
Returns a term's 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.
complexSearchByTermXML Returns all AGROVOC terms starting with the list of multiple words passed as parameters. Refer to the Web Services documentation below for the details of use.