Skip to content

Terminological web services tools

diego ferreyra edited this page Jun 12, 2024 · 1 revision

Table of Contents

Accepted params
  - task : Action to do
  - arg: arguments for task action (eg: string for search task, numerical id for specific term data)
  - output: Output format, can be JSON or XML. Optional parameter, XML by default 
Accepted Tasks and Args

fetchRelated

Retrieve related terms for one ID

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchRelated&arg=1

fetchAlt

Retrieve alternative/non prefered terms for one ID

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchAlt&arg=1

fetchDown

Retrieve more specific terms for one ID

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchDown&arg=1

fetchUp

Retrieve hierarchical structure for one ID

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchUp&arg=1

fetchTerm

Retrieve simple term data

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchTerm&arg=1

fetchNotes

Retrieve notes for one term

  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchNotes&arg=1

fetchDirectTerms

 Retrieve alternative, related and direct hierarchical terms for one term_id 
  * arg: one ID (int)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchDirectTerms&arg=1

fetchTopTerms

 Retrieve vocabulary top terms
  * arg: none
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchTopTerms

fetchTerms

 Retrieve simple term data for some coma separated IDs (example: 3,6,98) 
  * arg: some coma separated IDs (for example: arg=3,6,98)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchTerms&arg=1,2,4

fetchRelatedTerms

 Retrieve simple related term data for some coma separated terms IDs (example: 3,6,98) 
  * arg: some coma separated IDs (for example: arg=3,6,98)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchRelatedTerms&arg=1,4

letter

 Search and retrieve terms was beginning with letter $arg
  * arg: one letter (for example: arg=a)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=letter&arg=a

search

 Search and retrieve terms
  * arg: search expresion (string)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=search&arg=peace

fetchSimilar

Search and retrieve similar term for string search expresion ($arg)

  * arg: string (for example: arg=trrends)
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=letter&arg=a

fetchVocabularyData

 Retrieve data about vocabulary
  * arg: none
  * Example: http://www.r020.com.ar/tematres/demo/services.php?task=fetchVocabularyData

Examples and inspirations