SWIM Supporting Material

SWIM-DEFN-270 Service operations

Requirement

Title

Service operations

Identifier

SWIM-DEFN-270

Requirement

A service definition shall include or refer to information about the expected exposed service operations including:

  • the name of the service operation; and

  • a description of the intent and the results of the service operation.

Rationale

The service provider should be aware of the service operations to be implemented

Verification

Completeness: Verify that all service operations are described.

Consistency: Verify the service operations against the messaging technology needs.

Correctness: Not Applicable.

Examples/Notes

Example

  • operation name: queryDataSets

  • description: The operation accepts criteria about data sets and returns a list with the metadata about the corresponding data sets.

Note: Service operations can be grouped under service interfaces.

Note: When the operations 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 operations.

Level of
Implementation

Mandatory

Guidance

Technical View

  • The service operations provide a technical view of the interactions with the service.

  • The service functions described in SWIM-DEFN-140 Service functions provide a business view of the interactions with the service.

Verification Support

Completeness

Check that:

[  ] The service definition includes or refers to information about the exposed service operations.

[  ] The  information about the service operations includes the name of the service operation.

[  ] The  information about the service operations includes a description of the intent and the results of the service operation.

Consistency

Check that:

[  ] The service operations are consistent with the messaging technology needs.

Examples

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

Status: Living Material