Interface descriptions and input params for Data sources - production

Owned by Kurt Hansen
Aug 02, 2024
1 min read

This page contains information regarding the interfaces the Data source publish to be used by the Orchestration component and the input parameters that must be supported by the interfaces.

Editor: Kurt Hansen

 

Introduction

Interface description is documented for each data model supported by the Orchestration component. If more than one version of the interface description is supported, there will be one document for each version.

This page only contains the latest version of the interface description for each data model, because this version is mandatory for new Data source.

Interface description

Interface description can be found at this page:

Error handling

Errors that are observed on a call to a Data source interfaces are handled by error handling logic in the Orchestration component, but are further reported to Display clients in the orchestrated data that is returned to the Display client.

The following error codes and error text can be returned by the Orchestration component:

Type

Title

Status

Agreement-error

Internal error in OK during agreement control

500

Data-source-error

Error calling data source

Get from Data source response status

Data-source-timeout-error

Timeout reached for data source

408

Data-source-internal-error

Internal error at data source

500

Data-source-security-error

Security validation error when calling data source

400

Data-source-format-error

Invalid format in response from data source

422

Input-param-error

Invalid input parameter from display client

400

Circuit-breaker-error

Circuit breaker is currently active for data source

502

Data-validation-error

Validation error of data in response from data source

400

Errors are returned in a generic error structure that is compliant with RFC 7807.

 

 

Version Date Comment
Current Version (v. 1) Aug 02, 2024 11:28 Kurt Hansen