Technical
description scope-rest-webservices
Partner API
Purpose
The Partner API offers read-only endpoints for retrieving business partner master data from Scope in an XML/JSON data format.
The API includes the following data:
- General partner information
- Registration IDs
- Partner contacts
- Selected debtor profile details
- Selected creditor profile details
API response
The API returns data in either XML or JSON format, with both formats following the same data structure.
Current XML schema version 4: partner-v4.xsd
Imported schemas:
Starting with version 4, a new naming scheme has been introduced. Schema files for previous versions are not available online.
Examples:
- partners-example-4.0.xml
- partners-example-4.0.json
- partners-example-4.1.xml
- partners-example-4.1.json
Minor versions
To enable incremental and backward‑compatible changes, our APIs support minor versions through
an additional request parameter minorVersion. This parameter allows you to target a specific,
stable version of an API entity that your application depends on.
Using minor versions is optional. When the API schema changes, you can either continue working with your current version or update the minor version parameter to adopt the latest version.
Minor version 1
- Adds a subelement
rolesto the partner, that provides identifiers for the associated roles (e.g. agent, airline, …). The list of roles are documented in partner-v4.xsd.
API documentation
The API is documented using an OpenAPI specification, enabling tools like Swagger to visualize the API and generate code in multiple programming languages.
Version 4
- Open in Swagger Editor Next
- Specification file: partner-api-4.0.json