SWIM Supporting Material

SWIM-DEFN-280 Service messages

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

Requirement

Title

Service messages

Identifier

SWIM-DEFN-280

Requirement

A service definition shall include or refer to information about the expected messages that are exchanged by the service including input, output and error messages.

Rationale

The service provider should be aware of the service messages to be implemented.

Verification

Completeness: Verify that all service messages are described.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Note: There needs to be at least one message.

Note: Service messages can be linked to service operations.

Example:

  • QueryDataSetsRequest, QueryDataSetsReply

Note: When the messages are used as defined by the protocol selected in SWIM-DEFN-260 there is no need to repeat them in the service definition. This covers, for example, the Open Geospatial Consortium's Web Feature Service that has standardised request and response messages.

Level of
Implementation

Mandatory

Guidance

Verification Support

Completeness

Check that:

[  ] The service definition includes or refers to information about the input messages that are exchanged by the service.

[  ] The service definition includes or refers to information about the output messages that are exchanged by the service.

[  ] The service definition includes or refers to information about the error messages that are exchanged by the service.

Examples

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

Status: Living Material