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

JSON Guidance related to Service Overview

This is guidance for producing JSON service descriptions related to satisfying the needs identified in the ICAO notion of Service Overview.

Requirement

Identifier

SERV-OVW-007

Field name

Geographical Extent of Information

Detailed content

Description on the details of the geographic coverage of the information provided by the information service; could be expressed in terms of ICAO region, FIR, Aerodrome, polygon, etc.

Template

Free text

ExampleDONLON Airport
Rationale and Guidance

Rationale: Allow consumer to understand the geographical coverage of the information being provided.

Guidance: Geographical coverage may be expressed in terms of ICAO region, FIR, Aerodrome, polygon/geobox, etc.

Note: that listing more granular information (e.g. coverage at Airport X, FIR Y) may facilitate search responses when provided textual (vs. graphically).

Level of Implementation

Mandatory

Guidance

N/A

Guidance for JSON service description

tentative JSON Guidance

note

The requirement SWIM-REG-0004 Service categorization defines geographical extent in terms of State, FIR and Aerodromes. These uses are not repeated here.

Schema

The guidance concerns JSON Schema v0.0.3 (see Schema releases). 

 Schema excerpt [+]
	
		"ServiceGeneralDescription" : 
		{
			"description" : "Description of the service in terms of what it provides, the purpose and under which conditions and quality levels the service is provided.",
			"type": "object",
			"additionalProperties": false,
			"required": ["operationalNeed", "functionality", "qualityOfService", "accessAndUseCondition", "validation"],
			"properties":
			{
				...
				"concepts":
				{
					"description" : "Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields.",
					"type" : "array",
					"items" : { "$ref":"#/definitions/Concept" }
				},
				...
			}
		},


		"Concept" : 
		{
			"description" : "Optional information intended for a good understanding of the service. This may cover design concepts related to the service, logical model, design considerations, or any other information not pertaining to the other fields.",
			"type": "object",
			"additionalProperties": false,
			"required": ["name", "description"],
			"properties":
			{
				"description":
				{
					"description" : "Description of the concept.",
					"type" : "string",
					"minLength":1
				},
				"name":
				{
					"description" : "The name of the concept.",
					"type" : "string",
					"minLength":1
				}
			}
		},
 Rules [+]

This is optional information.

Guidance


info

The JSON schema does not provide specific attributes to capture information in addition to State, FIR and Aerodromes as in SWIM-REG-0004 Service categorization.

As a consequence the Concept structure within the schema will be used to capture any additional geographical extent info (see more on the concept structure in SWIM-SERV-ADD Additional info).


In case you have information on the geographical extent, in addition to the one already provided within SWIM-REG-0004 Service categorization (which covers State, FIR and Aerodrome), use the following.

Within field concepts, itself within field serviceGeneralDescription, use one instance of the Concept type.

Concept type

Fill in the following attributes.

attribute nameguidancerule
name Use name "Geographical extent"Mandatory
description Describe the geographical extent in terms of bounding box, ICAO Region, and any other textual descriptionMandatory


Example

case 1 - sources are included
		"serviceGeneralDescription": {
			
			"concepts": [
				{
					"name": "Geographical extent",
					"description": "The service applies for flights in the EUR ICAO Region only."
				}
			]
  • No labels