SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Page Table of Contents

XML schema example

Caveat

The example is for illustrative purposes. It shows how an example with content and embedded semantic correspondence statements. However, the example does not show you how to build a XML schema definition for any particular service. In particular, the design options e.g. using elements/complex types should not be taken as definitive.

The XML schema example below is aligned with the service description for the Donlon TOBT Setting Service Description. The service supports the Airport Collaborative Decision Making (A-CDM) concept and its implementation by allowing A-CDM partners, typically aircraft operators and ground handlers, with the capability to set the Target Off-Block Time (TOBT) that indicates the target time for the aircraft to be ready for Off-Block.

The example schema covers four the messages that are part of the service: TOBTSettingRequest, TOBTSettingResponse, TOBTDeleteRequest and TOBTDeleteResponse.

Examples of two of these messages are included to promote an easier understanding of the schema.

DonlonTOBTSettingServiceInformationDefinition


DonlonTOBTSettingServiceInformationDefinition.xsd 
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:don="http://www.swim.donlon-airport.com/swim-ops/gateway" targetNamespace="http://www.swim.donlon-airport.com/swim-ops/gateway" elementFormDefault="qualified" attributeFormDefault="unqualified" xml:lang="eng">
	<!--
====================================
information definition level 
====================================
-->
	<xs:annotation>
		<xs:documentation>
			<!--SWIM-INFO-003-->
			<identification>
				<title>Donlon TOBT Setting Service Information Definition</title>
				<edition>0.93</edition>
				<referenceDate>2018-10-17</referenceDate>
			</identification>
			<!--SWIM-INFO-004-->
			<responsibleParty>
				<responsiblePartyName>Donlon Airport Operator</responsiblePartyName>
				<contactDetails>http://www.donlon-airport.com/swim/service-request</contactDetails>
				<role>author</role>
			</responsibleParty>
			<!--SWIM-INFO-005-->
			<scope>Information in support of the Donlon TOBT Setting Service. This includes the Target Off-Block Time and Flight Identification types needed for the TOBTSetting Request, TOBT Delete Request messages. It also includes the ResponseStatus type needed by the TOBT Setting Response and TOBT Delete Response maessages.</scope>
		</xs:documentation>
	</xs:annotation>
	<!--
====================================
message types
====================================
-->
	<xs:element name="TOBTSettingRequest" id="donlon002">
		<xs:complexType>
			<xs:annotation>
				<xs:documentation>Message which provides the Target Off-Block Time value of a specific flight.</xs:documentation>
				<xs:documentation>
					<semanticCorrespondence>
						<outOfScope rationale="container"/>
					</semanticCorrespondence>
				</xs:documentation>
			</xs:annotation>
			<xs:sequence>
				<xs:element name="tobt" type="don:TargetOffBlockTime" id="donlon003" minOccurs="1" maxOccurs="1">
					<xs:annotation>
						<xs:documentation>The Target Off-Block Time value to be set. TOBT is the time that an operator / handling agent estimates that an aircraft will be ready, all doors closed, boarding bridge removed, push back vehicle present, ready to start up / push back immediately upon reception of clearance from the TWR.</xs:documentation>
						<xs:documentation>
							<semanticCorrespondence>
								<mapping>
									<trace>urn:x-ses:sesarju:airm:v420:ConceptualModel:Subjects:Flight:FlightEvent:TargetOffBlockTime</trace>
									<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Flight:FlightEvent:OffBlockReady@time</trace>
									<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Common:Codelists:CodePlanningStatusType@TARGET</trace>
								</mapping>
							</semanticCorrespondence>
						</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="flightId" type="don:ICAOFlightIdentification" id="donlon004" minOccurs="1" maxOccurs="1">
					<xs:annotation>
						<xs:documentation>The ICAO identifier of the specified flight</xs:documentation>
						<xs:documentation>
							<semanticCorrespondence>
								<outOfScope rationale="container"/>
							</semanticCorrespondence>
						</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="TOBTSettingResponse" id="donlon031">
		<xs:complexType>
			<xs:annotation>
				<xs:documentation>Message which responds the validity of a previously sent TOBTSettingRequest message.</xs:documentation>
				<xs:documentation>
					<semanticCorrespondence>
						<outOfScope rationale="container"/>
					</semanticCorrespondence>
				</xs:documentation>
			</xs:annotation>
			<xs:sequence>
				<xs:element name="responseStatus" type="don:ResponseStatus" id="donlon005" minOccurs="1" maxOccurs="1">
					<xs:annotation>
						<xs:documentation>Status of the response to the service request</xs:documentation>
						<xs:documentation>
							<semanticCorrespondence>
								<outOfScope rationale="container"/>
							</semanticCorrespondence>
						</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="TOBTDeleteRequest" id="donlon032">
		<xs:complexType>
			<xs:annotation>
				<xs:documentation>Message which requests deleting the last TOBT value of the specified flight.</xs:documentation>
				<xs:documentation>
					<semanticCorrespondence>
						<outOfScope rationale="container"/>
					</semanticCorrespondence>
				</xs:documentation>
			</xs:annotation>
			<xs:sequence>
				<xs:element name="flightId" type="don:ICAOFlightIdentification" id="donlon006" minOccurs="1" maxOccurs="1">
					<xs:annotation>
						<xs:documentation>The ICAO identifier of the specified flight</xs:documentation>
						<xs:documentation>
							<semanticCorrespondence>
								<outOfScope rationale="container"/>
							</semanticCorrespondence>
						</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="TOBTDeleteResponse" id="donlon042">
		<xs:complexType>
			<xs:annotation>
				<xs:documentation>Message which responds the validity of a previously sent TOBTDeleteRequest message.</xs:documentation>
				<xs:documentation>
					<semanticCorrespondence>
						<outOfScope rationale="container"/>
					</semanticCorrespondence>
				</xs:documentation>
			</xs:annotation>
			<xs:sequence>
				<xs:element name="responseStatus" type="don:ResponseStatus" id="donlon007" minOccurs="1" maxOccurs="1">
					<xs:annotation>
						<xs:documentation>Status of the response to the service request</xs:documentation>
						<xs:documentation>
							<semanticCorrespondence>
								<outOfScope rationale="container"/>
							</semanticCorrespondence>
						</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<!--
====================================
complex types
====================================
-->
	<xs:complexType name="ICAOFlightIdentification">
		<xs:annotation>
			<xs:documentation>Flight identification structure based on usual ICAO fields present in the Flight Plan</xs:documentation>
			<xs:documentation>
				<semanticCorrespondence>
					<outOfScope rationale="container"/>
				</semanticCorrespondence>
			</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="aircraftIdentification" type="don:AircraftIdentification" id="donlon008" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Name used by ATS units to identify and communicate with the aircraft.</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<mapping>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Flight:FlightIdentifier:AircraftIdentification</trace>
							</mapping>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="estimatedOffBlockTime" type="don:EstimatedOffBlockTime" id="donlon009" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Date and time at which the aircraft will off-block according to ICAO flight plan field.</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<mapping>
								<trace>urn:x-ses:sesarju:airm:v420:ConceptualModel:Subjects:Flight:FlightEvent:EstimatedOffBlockTime</trace>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Flight:FlightEvent:OffBlock@time</trace>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Common:Codelists:CodePlanningStatusType@ESTIMATED</trace>
							</mapping>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="icaoDepartureAerodrome" type="don:ICAODepartureAerodrome" id="donlon011" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>ICAO code of the scheduled departure aerodrome.</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<mapping>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodrome@locationIndicatorICAO</trace>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Flight:Flight@departureAerodrome</trace>
							</mapping>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="icaoArrivalAerodrome" type="don:ICAOArrivalAerodrome" id="donlon010" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>ICAO code of scheduled destination aerodrome.</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<mapping>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:BaseInfrastructure:AerodromeInfrastructure:Aerodrome@locationIndicatorICAO</trace>
								<trace>urn:x-ses:sesarju:airm:v420:LogicalModel:Subjects:Flight:Flight@destinationAerodrome</trace>
							</mapping>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ResponseStatus">
		<xs:annotation>
			<xs:documentation>Status of the response to the service request</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="reasonForRejection" type="don:ReasonForRejection" id="donlon012" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Code or textual description on the reason for rejection.</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<outOfScope rationale="messaging"/>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
			<xs:element name="status" type="don:Status" id="donlon013" minOccurs="1" maxOccurs="1">
				<xs:annotation>
					<xs:documentation>Specifies whether the related request has been accepted or not. Values: ACCEPTED, REJECTED</xs:documentation>
					<xs:documentation>
						<semanticCorrespondence>
							<outOfScope rationale="messaging"/>
						</semanticCorrespondence>
					</xs:documentation>
				</xs:annotation>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<!--
====================================
simple types
====================================
-->
	<xs:simpleType name="TargetOffBlockTime" id="donlon021">
		<xs:restriction base="xs:dateTime"/>
	</xs:simpleType>
	<xs:simpleType name="AircraftIdentification" id="donlon022">
		<xs:restriction base="xs:string"/>
	</xs:simpleType>
	<xs:simpleType name="EstimatedOffBlockTime" id="donlon023">
		<xs:restriction base="xs:dateTime"/>
	</xs:simpleType>
	<xs:simpleType name="ICAOArrivalAerodrome" id="donlon024">
		<xs:restriction base="don:ICAOAerodromeLocationIndicator"/>
	</xs:simpleType>
	<xs:simpleType name="ICAODepartureAerodrome" id="donlon025">
		<xs:restriction base="don:ICAOAerodromeLocationIndicator"/>
	</xs:simpleType>
	<xs:simpleType name="ICAOAerodromeLocationIndicator" id="donlon026">
		<xs:restriction base="xs:string">
			<xs:length value="4"/>
		</xs:restriction>
	</xs:simpleType>
	<xs:simpleType name="ReasonForRejection" id="donlon027">
		<xs:restriction base="xs:string"/>
	</xs:simpleType>
	<xs:simpleType name="Status" id="donlon028">
		<xs:restriction base="xs:string">
			<xs:enumeration value="ACCEPTED"/>
			<xs:enumeration value="REJECTED"/>
		</xs:restriction>
	</xs:simpleType>
</xs:schema>

Example XML based on the schema

TOBTSettingRequest

The following example illustrates what the TOBTSettingRequest would look like based on the example schema.

TOBTSettingRequest.xml 
<?xml version="1.0" encoding="UTF-8"?>
<don:TOBTSettingRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:don="http://www.swim.donlon-airport.com/swim-ops/gateway" xsi:schemaLocation="http://www.swim.donlon-airport.com/swim-ops/gateway DonlonTOBTSettingServiceInformationDefinition.xsd">
	<don:tobt>2018-06-25T09:32:00Z</don:tobt>
	<don:flightId>
		<don:aircraftIdentification>TAP847</don:aircraftIdentification>
		<don:estimatedOffBlockTime>2018-06-25T09:20:00Z</don:estimatedOffBlockTime>
		<don:icaoDepartureAerodrome>EADD</don:icaoDepartureAerodrome>
		<don:icaoArrivalAerodrome>LPPT</don:icaoArrivalAerodrome>
	</don:flightId>
</don:TOBTSettingRequest>

TOBTDeleteRequest

The following example illustrates what the TOBTDeleteRequest would look like based on the example schema.

TOBTDeleteRequest.xml 
<?xml version="1.0" encoding="UTF-8"?>
<don:TOBTDeleteRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:don="http://www.swim.donlon-airport.com/swim-ops/gateway" xsi:schemaLocation="http://www.swim.donlon-airport.com/swim-ops/gateway DonlonTOBTSettingServiceInformationDefinition.xsd">
	<don:flightId>
		<don:aircraftIdentification>TAP847</don:aircraftIdentification>
		<don:estimatedOffBlockTime>2018-06-25T09:20:00Z</don:estimatedOffBlockTime>
		<don:icaoDepartureAerodrome>EADD</don:icaoDepartureAerodrome>
		<don:icaoArrivalAerodrome>LPPT</don:icaoArrivalAerodrome>
	</don:flightId>
</don:TOBTDeleteRequest>




  • No labels

Status: Living Material