Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service provider |
Identifier | SWIM-SERV-008 |
Requirement | A service description shall include the following information about the service provider:
|
Rationale | Knowing the service provider is essential to business experts. Point of contact allows getting additional information regarding the service. |
Verification | Completeness: Verify that the elements are included. Consistency: Not Applicable. Correctness: Not Applicable. |
Examples/Notes | Example contact information:
Example points of contact:
Note: Consider including information on provider certification when relevant for the service being described (e.g. for a Meteorological service). |
Level of Implementation | Mandatory |
Guidance
Examples
See the Service Provider section within the Donlon TOBT Setting Service Description.
Guidance for JSON service description
JSON Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
JSON Guidance
Within field serviceProvision, itself within field informationService, fill all fields of ServiceProvision.
Service Provision - Mandatory
attribute name | description | type | guidance | rule |
---|---|---|---|---|
provider | The full official name of the organisation. [SWIM-SERV-008] | string | Provide the name of the organisation responsible for the service Rationale: Knowing the service provider is essential to business experts. | Mandatory |
providerDescription | Description of the organisational unit responsible for the service. [SWIM-SERV-008] | string | Provide a small description of the organisation and/or the unit responsible for the service Consider including information on provider certification when relevant for the service being described (e.g. for a Meteorological service). | Mandatory |
providerType | The type of service provider. | Select one or more code values | Mandatory, minItems=1 | |
dateInOperation | Date at which the service version went into operation (or is planned to become operational.) | string | Provide the date at which this service version became operational. Note: The date at which the service became operational for the first time may be mentioned in the service abstract. | Mandatory, format is "yyyy-mm-dd" |
serviceSupport | Provision of material and guidance necessary for the use of the information service. | string | Specify days and hours the information service provider can be contacted by users requiring support for the provided service. A description of the support a provider is offering to consumers on all relevant aspects related to the information service. Rationale: Consumer needs will vary and may require different levels of provider support. | Optional |
pointOfContact | A person or group within the service provider organization, suitable for making a human contact for any purpose. [SWIM-SERV-008] | PointOfContact | Provide one or more points of contact where additional information can be obtained, including name, contact information and role. | Mandatory, minItems=1 |
PointOfContact - Mandatory - one or more
attribute name | description | type | guidance | rule |
---|---|---|---|---|
name | The name of the point of contact. | string | Mandatory | |
description | The description of the point of contact. | string | Describe the role / function of the point of contact. When applicable add contact info such as URL link or postal address. | Mandatory |
An electronic mail address used to correspond in writing with the point of contact. | string | Provide email address if available. | Optional | |
phoneNumber | A telephone number used to communicate orally with the point of contact. | string | Provide phone number if available. | Optional |
contact info is required
At least one contact information is required for each point of contact.
- provide email address and/or phone number in corresponding field(s)
- provide other contact info, such as postal or URL, in field description
JSON example
"informationService": { "serviceProvision": { "provider": "Donlon Airport Operator", "providerDescription": "Donlon Airport Operator is the organisation responsible for all operations at Donlon airport.", "providerType": [ "AIRPORT_OPERATOR" ], "dateInOperation": "2019-05-15", "serviceSupport": "For Incidents on services in operation, contact the Service desk [24/7]: +693 555 01 [email protected]", "pointOfContact": [ { "name": "Customer Relations", "description": "to request access to the service, use following link http://www.donlon-airport.com/swim/service-request", "email": "", "phoneNumber": "" }, { "name": "service support", "description": "For any issues relate to the operation of the Donlon service", "email": "[email protected]", "phoneNumber": "+693 555 01" } ] } }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.