SWIM Supporting Material

SWIM-DEFN-260 Service interface protocols and data format

Owned by WILSON Scott
Last updated: 2024 Jul 11
1 min read

Requirement

Title

Service interface protocols and data format

Identifier

SWIM-DEFN-260

Requirement

A service definition may include or refer to information about:

  • the service interface protocols (including name and version); and

  • data format to be used.

Rationale

The service provider should be aware if any protocol and data format is to be implemented.

Requiring that specific protocols and data formats are implemented enforces interoperability between the service provider and the service consumer.

Verification

Completeness: Not Applicable.

Consistency: If provided, verify that the protocols and data format are consistent with the service interface binding.

Correctness: Not Applicable.

Examples/Notes

Example:

  • transport / messaging protocols: The service shall use TLS1.2 or later in accordance with EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile.

  • data format: The service shall offer data in XML and JSON data format.

Example:

  • The service shall offer the data in binary data format.

Note: The service message (SWIM-DEFN-280) may detail a schema for the data format.

Level of
Implementation

Optional

Guidance

Protocols are normally linked to the service interface binding. The information provided here must be consistent with what is selected in SWIM-DEFN-255.

If a data format is listed, it must be consistent with what is allowed by the bindings mentioned in SWIM-DEFN-255.

Verification Support

Consistency

Check that:

[  ] The protocols are consistent with the selected interface binding.

Examples

Links to example service definitions can be found in the example service definitions page. 

Status: Living Material