ECLASS Webservice

From wiki.eclass.eu
Revision as of 15:46, 4 May 2021 by Hoffmann (talk | contribs) (→‎=Information material)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

ECLASS Structure Elements and Mappings can be accessed via a RESTful Webservice as XML or JSON. A certificate is required for authentication, which can be acquired, renewed or revoked through the ECLASS DownloadPortal. The Webservice is provided by the ECLASS CDP

Motivation

ECLASS releases have until now been solely delivered as sets of huge files containing a complete ECLASS release. Applications, however, often need only a subset of the ECLASS structure elements, e.g. a particular class with some of its properties and values -- and they need so on demand. Therefore ECLASS is now offering RESTful Webservices, which allow to obtain self-contained classes, properties, units and mappings without the need to handle the complete fileset of an ECLASS XML release.

ECLASS Download API XML

The ECLASS Download API XML supports retrieval of individual classes (Classification Class, Application Class, Aspect or Block) and properties by their IRDI.

The system returns a self-contained eClassXML 3.0 file for the requested structure element.

Self-contained means that not only the requested element itself but also its referenced elements are contained in the result.

Furthermore, the ECLASS Download API XML supports retrieval of units of measurement by their IRDI. Here also, the system returns a self-contained eClassXML 3.0 file for the requested structure element.

The RESTful API for the XML retrieval is documented in SwaggerHub.

ECLASS Download API XML - Examples

As shown above, the Webservice is a function of the CDP. For the XML download, the defined endpoints must therefore be applied to the CDP URL "https://www.eclass-cdp.com/"

To retrieve a class via IRDI (e.g. 0173-1---ADVANCED_1_1#01-ADN862#010) the following URL is necessary:

https://eclass-cdp.com/xmlapi/v1/classes/0173-1---ADVANCED_1_1%2301-ADN862%23010

Note: The # in the IRDI has to be URL encoded via %23

This URL can now be retrieved using a client, such as a browser.

Similarly, a property call works (e.g. 0173-1#02-AAS574#002):

https://eclass-cdp.com/xmlapi/v1/properties/0173-1%2302-AAS574%23002

ECLASS Download API JSON

In addition to a fundamentally different serialization of the ECLASS structure elements using JSON, the JSON API also extends the functionalities in contrast to the XML retrieval.

In general, specific endpoints exist for each structure element type. In addition, there is the possibility of a list retrieval for each structure element type. In this list retrieval it is also possible to search for elements via the preferred name.

The RESTful API for the JSON retrieval is documented in SwaggerHub.

ECLASS Download API JSON - Examples

The examples for the XML API lead here accordingly to the following URLs:

To retrieve an Application Class via IRDI (e.g. 0173-1---ADVANCED_1_1#01-ADN862#010) the following URL is necessary:

https://eclass-cdp.com/jsonapi/v1/applicationClasses/0173-1---ADVANCED_1_1%2301-ADN862%23010

Similarly, a property call works (e.g. 0173-1#02-AAS574#002):

https://eclass-cdp.com/jsonapi/v1/properties/0173-1%2302-AAS574%23002

Information material

Please find in the following a short introduction to the ECLASS Webservice: ECLASS WEBSERVICE - Retrieval of ECLASS content via Webservice

Related Information