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:
https://api.itscope.com/2.1/info/schema/standard.xsd
URL for schema definition of the standard update data output format:
https://api.itscope.com/2.1/info/schema/standardupdate.xsdInstructions 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
or https://msdn.microsoft.com/en-us/library/x6c1kb0s%28v=VS.100%29.aspx
API client for different developer languages
API clients can be generated using the openAPI specification issued by ITscope. This generates the necessary API data models and API documentation. These clients are intended to serve as a framework for an application, saving work but not yet providing a complete client. This means that individual customisation will be necessary. If the XML format is used, a function for deserialising an XML string must also be implemented.
With the help of the openapi generator, a client can be easily translated into different languages.
openapi-generator generate -i https://api.itscope.com/2.1/openapi.json -g java -o ./clientPostman
For users of Postman, we have created a project that contains all the endpoints of our API version 2.1. The requests are documented in Postman.
Postman can be downloaded here.
After downloading, Postman will ask you if you want to register. You can also skip the registration process: ‘Skip signing in and take me straight to the app’.
You can find the dowload of the Postman Project at the bottom of this page.
In Postman, choose a workspace and press the Import button.
The following variables are already created in Postman and can be filled with your API credentials.
| Variable | Description | Example |
| baseUrl | The ITscope API url and version | https://api.itscope.com/2.1 |
| Account_ID | The ITscope account ID (as username) | m123456 |
| API_KEY | The API key (as a password) | abc123de_f456… |
Save the variables. Postman is now ready to start.