Data Model from XML Schema (XSD)
The data model for the ITscope data formats can be retrieved in XML Schema (XSD) using the interactive API, via the API method info. No API key is required for this retrieval. Simply set the data output format as the URL path.
URL for schema definition of the standard data output format.
URL for schema definition of the standard update data output format.
URL for schema definition of the developer data output format.
URL for schema definition of the developer update data output format.
Instructions for Java
The result of the API retrieval for the schema depending on the data format, i.e. the XML definition, can then be stored locally on the hard disk, e.g. under c:\temp\itscope_api.xsd
The Java binding compiler (xjc.exe) can now create a Java class model using to the XML definition.
This call creates a package named en.itscope.api.
‘c:\Program Files\Java\jdk1.7.0_51\bin\xjc.exe’ -p en.itscope.api c:\temp\itscope_api.xml
Instructions for C#, .NET and VB.NET
These are some example tools or instructions for generating schemas.
- XML schema definition tool (Xsd.exe) directly in VisualStudio. See the following links for instructions: https://msdn.microsoft.com/de-de/library/x6c1kb0s%28v=vs.120%29.aspx
- xsd2Code community edition .net class generator from XSD schema
API client for different developer languages
The API clients can be generated with the public framework used by ITscope, Swagger (see http://www.swagger.io), to create API data models and API documentation. These clients should serve as a framework for an application, which should save work, but does not yet deliver a complete client. This means individual customisation is necessary. If the XML format is used, a function for deserialising an XML string must be implemented.
The online Swagger editor can create a client in many developer languages based on the ITscope API definition.
After importing the URL, some errors are shown in the right-hand area, these can be ignored and closed with the ‘Collapse’ button. The client can be generated despite these errors.
Afterwards, the respective client can be selected for download via the ‘Generate Client‘ menu item.
List of possible clients:
- Akka Scala
- Async Scala
- C# .NET 2.0
- Dynamic HTML
- QT 5 C++
- Typescript Angular
- Typescript Angular 2
- Typescript Fetch
- Typescript Node
For Postman users we have created a project that contains all endpoints of our API version 2.0. The requests are documented in Postman and all parameters are already specified.
Postman can be downloaded here.
After the download you will be asked by Postman if you want to register. You can also skip the registration by selecting ‘Skip signing in and take me straight to the app’.
Now open the ITscope project on Postman:
Then click ‘Run in Postman’ in the upper right-hand corner of the web page and select ‘Postman for Windows’ if you have the Windows version, or select ‘Postman for Chrome’ if you have installed Postman as a Chrome plugin.
Postman will open and automatically import the ITscope project into the workspace.
Select the ‘PRODUCTION’ environment in the top right-hand corner. This determines the host to be used and the API version.
Next, you must create the global variables listed below (called globals). To do this, click on the ‘Eye icon’ in the top right-hand corner and click on ‘Edit’ in the ‘Globals’ section.
The following global variables have to be added in Postman:
|Type||Data format for the communication with the API: JOSN or XML||XML|
|Account-ID||The ITscope Account-ID (as username)||m123456|
|API-Key||The API-Key (as password)||abc123de_f456…|
Now click on ‘Save’. Postman is now ready to go.