Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-008 Service provider

Requirement

Title

Provider point of contact

Identifier

SWIM-SERV-070

Requirement

A service description should include information about where additional information on the service can be obtained, including:

  • name;
  • contact information; and
  • role.

Rationale

This provides the service consumer with a link to be used if more information on the service is needed and details on where to require access.

Point of contact allows getting additional information regarding the service.

Verification

Completeness: Not Applicable.

Consistency: Not Applicable.

Correctness: If provided, check that the information is correct.

Examples/Notes

Note: The additional information could be more technical information on the service.

It is best practice to provide a link to where the information is found.

Example contact information:

  • email address;
  • postal address;
  • phone number;
  • URL.

Note: The point of contact’s name is usually that of a role acting as a single point of contact rather than the name of a specific person.

Example:

  • “Customer Relations, to request access to the service, http://www.donlon-airport.com/swim/service-request”;

Level of Implementation

Recommended

Guidance

The point of contact can have multiple roles. For example it may be:

  •  customer relations covering the basics on how to gain access to the service;
  • a url that allows a potential service consumer to download technical details and user manuals about the service.

Verification Support

Correctness

Check that:

[  ] The name of the provider point of contact is correct.

[  ] The contact information of the provider point of contact is correct.

[  ] The role of the provider point of contact is correct.

Examples

The following example shows the content as a table.

service provider

provider point of contact

name

Customer Relations

contact informationURL: http://www.donlon-airport.com/swim/service-request
roleTo request access to the service.

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-070 using Service Metadata Schema
"serviceProvider": {
...
 "pointOfContact": [{
  "name": "Customer Relations",
  "contactInformation": [{
   "type": "URL",
   "address": "http://www.donlon-airport.com/swim/service-request"
  }],
 "role": "To request access to the service."
 }]
}

Complete examples are available at Example service description.

  • No labels