Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service access and use conditions |
Identifier | SWIM-SERV-013 |
Requirement | A service description shall include the conditions which apply to accessing and using the service, such as
|
Rationale | This requirement ensures that a service consumer is aware of any limitations on the access and use of the service. It is good practice to share business constraint information associated with the conditions of usage of the service. |
Verification | Completeness: Verify that the elements included cover the required constraints and policies. Consistency: Not Applicable. Correctness: Not Applicable. |
Examples/Notes | Example legal constraints:
Example services policies:
Example service consumption constraints:
Example security constraints:
Note: Additional use conditions could be diplomatic, geographical reasons, safety criticality and fees to be paid, for instance. |
Level of Implementation | Mandatory |
Guidance
No guidance provided.
Guidance for JSON service description
UNDERWORK
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
List the conditions that apply to access or use the service, so that a service consumer is aware of any limitations on the access and use of the service.
Within field accessAndUseCondition, itself within field serviceGeneralDescription, list one or more occurrences of type AccessAndUseCondition.
AccessAndUseCondition - Mandatory
A condition which applies to accessing and using the service, such as legal constraint, service policies, service consumption constraints and security constraints.
note
Concrete access control and other security mechanisms are described in the technical section of the form (see SWIM-SERV-019 Protocols and data format)
attribute name | description | type | guidance | rule |
---|---|---|---|---|
type | The type of service access or use condition. [SWIM-SERV-013] | Select the code value indicating the type of condition | Mandatory | |
name | The name of the condition. | string | Provide a short name for the condition. | Mandatory |
description | Description of the conditions that influence accessing and using the service, such as legal constraint; service policies; service consumption constraints | string | Describe the conditions which apply to accessing and using the service, so that the consumer is aware of any limitations on the access and use of the service. | Mandatory |
Example
"serviceGeneralDescription": { "accessAndUseCondition": [ { "type": "SECURITY_CONSTRAINT", "name": "User id + password", "description": "The access to the service is based on user id and password." }, { "type": "SECURITY_CONSTRAINT", "name": "SLA", "description": "The access to the service is subject to the signature of a Service Level Agreement with the Donlon Airport Operator." } ] }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.