Projekt Tezaurus pro obor zeměměřictví a katastru nemovitostí

Webová služba - Popis API rozhraní

U vyjmenovaných metod je možné přepínat mezi JSON a WSDL parametrem format (hodnota json nebo wsdl). Aktuální adresa rozhraní https://nlp.fi.muni.cz/projekty/tecu/webservice/api.rb

V případě chybného volání metody vrátí API chybové hlášení. Pro formát JSON objekt s parametry error=true a msg s popisem chyby. Pro formát WSDL se vrací XML dokument s elementy result=error a message s popisem chyby.

Vyhledávání

Parametry:

action
search
search
hledaný výraz
format
json/wsdl/html

Výsledek:

HTML: seznam vyhledaných termínů s odkazy na HTML reprezentaci hesla

JSON: pole objektů s nalezenými výsledky (každý objekt obsahuje ID hesla, termín a termín se zvýrazněním hledané části)

WSDL: XML dokument, ve kterém objekty result-entry obsahují nalezené výsledky (každý objekt obsahuje ID hesla, termín a termín se zvýrazněním hledané části)

Ukázka: api.rb?action=search&search=glob&status=1
api.rb?action=search&search=glob&status=1&format=html

Zobrazení hesla

Parametry:

action
getdoc
id
ID záznamu
format
json/wsdl/html

Výsledek:

HTML: HTML reprezentace podoby hesla

JSON: objektová reprezentace XML podoby hesla

WSDL: XML dokument hesla

Ukázka: api.rb?action=getdoc&id=1191&format=json
api.rb?action=getdoc&id=1191&format=html

Vyhledání hlavní úrovně tezauru

Parametry:

action
get_top
format
json/wsdl

Výsledek:

JSON: pole objektů s termíny (každý objekt obsahuje ID hesla, termín a počet podřízených termínů)

WSDL: XML dokument, ve kterém objekty result-entry obsahují nalezené výsledky (každý objekt obsahuje ID hesla, termín a počet podřízených termínů)

Ukázka: api.rb?action=get_top

Vyhledání podřízených hesel

Parametry:

action
get_subtree
id
ID hesla, pro které se hledají podřízené termíny
format
json/wsdl

Výsledek:

JSON: pole objektů s termíny (každý objekt obsahuje ID hesla, termín a počet podřízených termínů)

WSDL: XML dokument, ve kterém objekty result-entry obsahují nalezené výsledky (každý objekt obsahuje ID hesla, termín a počet podřízených termínů)

Ukázka: api.rb?action=get_subtree&id=30001

Vyhledání cesty ve stromu

Parametry:

action
get_path
id
ID hesla, pro které se hledá cesta
format
json/wsdl

Výsledek:

JSON: pole, které obsahuje ID hesel postupně od zadaného hesla ke kořenu stromu

WSDL: XML dokument, ve kterém objekty result-entry obsahují ID hesel postupně od zadaného hesla ke kořenu stromu

Ukázka: api.rb?action=get_path&id=1191

Export stromu v textové podobě

Parametry:

action
export_tree

Výsledek:

Stromová struktura tezauru v textové podobě

Ukázka: api.rb?action=export_tree

Vyznačení termínů v textu

Parametry:

action
highlight
text
volný text

Výsledek:

HTML reprezentace textu s odkazy na termíny tezauru

Ukázka: api.rb?action=highlight&text=....