How to Invoke the Web Service

Taxonomy Web Service allows external systems to retrieve the latest published version of all taxonomy trees, a specific taxonomy tree, a branch of a taxonomy tree or a view of a taxonomy tree in a Json format file. Once deployed, the web service can be invoked in many ways based on the integration requirements. This article describes the different ways to call the web service and what to expect as result.

Note: For Web Service Deployment, please refer to the article How to deploy the Taxonomy Web Service.

Retrieve all Taxonomy Trees

Calling The Web Service URL with no parameters allows external systems to obtain a Json formatted file that includes all the latest released versions of the taxonomy trees.

The taxonomy URL looks like this: 

https://[Azure function name].azurewebsites.net/api/TaxonomyReport?code=[azure function url codes]

Retrieve a Specific Taxonomy Tree

To retrieve a specific Taxonomy tree, add the parameter taxonomycode at the end of the URL followed by "=" and then followed by the taxonomy tree code that you want to retrieve.

Note: The different parameters and the URL must be separated with "&".

Example: 

https://[Azure function name].azurewebsites.net/api/TaxonomyReport?code=[azure function url codes]&taxonomycode=IS

Retrieve a specific branch of the Taxonomy Tree

To retrieve a specific branch of the taxonomy tree, add the parameter taxonomycode and the parameter taxonomyseries to the URL. The taxonomyseries is the Series Number of the branch you want to retrieve including the hierarchy of all its sub items.

Example: 

https://[Azure function name].azurewebsites.net/api/TaxonomyReport?code=[azure function url codes]&taxonomycode=IS&taxonomyseries=IS-01-020

Retrieve all items of a Taxonomy View

A taxonomy View is a collection of taxonomy items determined based on applied metadata filters and the definition of the view criteria. Read this article to learn more about working with Taxonomy Views.

To retrieve all items for a specific taxonomy view, add the parameter taxonomycode and the parameter taxonomyview to the URL. The taxonomyview is the English name of the taxonomy view as stated in its definition.

Example: 

https://[Azure function name].azurewebsites.net/api/TaxonomyReport?code=[azure function url codes]&taxonomycode=IS&taxonomyview=Human Resources Taxonomy

Additionally, you can retrieve a specific branch of a Taxonomy View if you add the parameter taxonomyseries with the top level series number of the branch to be retrieved.

Example: 

https://[Azure function name].azurewebsites.net/api/TaxonomyReport?code=[azure function url codes]&taxonomycode=IS&taxonomyview=Human Resources Taxonomy&taxonomyseries=IS-01-020

Example of the Json file