Service Description

 

 

asrv.aero

Helicopter Data Request Service

 

 

Until this note is removed the documentation is a work in progress, and revisions to the documentation will not be tracked.

 

Namespace: http://www.asrv.aero/restservices/1.0/helicopterdatarequestservice

 

Document revisions

Date
Description
Author
yyyy-mm-dd First complete version of the documentationOle Nymoen

 

 

 

1. Introduction

1.1. Overview

This service description defines a rest like interface to request helicopter oriented data. All flight related data elements are defined by the Airport Data Dictionary.

The service is primarily designed to meet the need of an airport to get data from helicopter operators on an airport. It is designed to be simple to implement.

While the entity definitions stay the same, the data they contain related to one flight will change as time goes by. Initially only schedule data will be available. The data content should then steadily increase as the flight progresses, until it is as complete as the service provider can make it.

1.2. Implementation considerations

Any implementation of this service MUST use the XSD files provided here: XSD files

It is however up to the service provider which data elements to support, and how much data to return for requests spanning a long time period. To enable this most elements are optional. The reason for a service provider to not support all elements might be business rules related to data distribution, that it doesn't have the information, or that it wants to provide information in other (more restricted) ways.

Any service provider should make available documentation about the actual implementation, including:

    • the address of the service.
    • any limitations in the implementation.
    • recommended and allowed polling intervals.

1.3. Purpose of this service description

This service description has the following purpose:

      • Describe of service in enough detail for a service provider to implement it.
      • Describe the service so that a client (of this service) developer can use it.
      • Make available the XSD files necessary to implement and use the service.
      • Make it possible for relevant people at airports, airlines, handlers and other aviation partners to understand the available functionality and then to decide if to implement/use it or not.

1.4. Intended readership

    • IT architects
    • Developers
    • Business architects
    • Interested parties in the aviation community

2. Service operations

2.1. HelicopterDataInbound

URL: http://......../HelicopterDataRequestService/HelicopterDataInbound.......

( heliFlightFilter : HeliFlighFilter ) : GetHeliDataInboundResponse

Returns data about the set of inbound helicopter flights that fit the heliFlightFilter. See the data definitions for documentation of parameters and return values.

The service is designed to be called regularly to provide an updated view of the helicopter traffic.

URL:

........./GetHeliDataInbound .................................................

Example:

.........xyzzy.........

2.2. HelicopterDataOutbound

( heliFlightFilter : HeliFlighFilter ) : GetHeliDataOutboundResponse

Returns data about the set of outbound helicopter flights that fit the heliFlightFilter. See the data definitions for documentation of parameters and return values.

The service is designed to be called regularly to provide an updated view of the helicopter traffic.

URL:

........./GetHeliDataInOutbound .................................................

Example:

.........xyzzy.........

3. Data entities

3.1. Delay

beskrivelse

delayCode

See DelayOrDiversionCode for definition of term.

DelayOrDiversionCode:

Numeric IATA delay/diversion code. Codes are defined in the IATA Airport Handling Manual chapter 730

delayReason

Textual description for the DelayCode, ref. DelayOrDiversionReason.

DelayOrDiversionReason:

Textual description for the DelayOrDiversionCode.

delayDuration

Duration of the delay. Typically used in conjunction with DelayCode. DelayDuration makes in theory possible to calculate a new estimated departure/arrival time, but in practice this is difficult as it isn't given what DelayDuration is relative to. 

duration:

XSD Duration type

The lexical representation for duration is the ISO 8601 extended format PnYnMnDTnHnMnS, where nY represents the number of years, nM the number of months, nD the number of days, 'T' is the date/time separator, nH the number of hours, nM the number of minutes and nS the number of seconds. The number of seconds can include decimal digits to arbitrary precision. P is required.

3.2. FlightLegIdentifier

This is the standard ADD FlightLegIdentifier. Only the relevant parts for helicopter lights will be used. None of the elements are required, but enough have to be present to actually uniquely identify a flight.

IFPLID

Defined by Eurocontrol as "A unique flight plan identifier, assigned by the IFPS". Two letters followed by eight digits.
callsign A call sign is used to uniquely identify an aircraft using the airspace around a particular airport.  Call signs in aviation are derived from several different policies, depending upon the type of flight operation. In most countries, unscheduled general aviation flights identify themselves using the call sign corresponding to the aircraft's registration number.  Commercial operators, including scheduled airline, air cargo and air taxi operators, will usually use an ICAO or FAA-registered call sign for their company. These will typically consist of the ICAO code of the operating airline followed by a flight identification.  The flight identification is very often the same as the flight number, but could be different due to call sign confusion, if two or more flights close to each other have similar flight numbers (i.e. KLM649 and KLM645 or BAW466 and BAW646).
aircraftRegistration An aircraft registration is a unique alphanumeric string that identifies an aircraft. In accordance with the Convention on International Civil Aviation all aircraft must be registered with a national aviation authority and they must carry proof of this registration in the form of a legal document called a Certificate of Registration at all times when in operation.

An aircraft can be re-registered in special cases, for instance if it's sold to an operator in another country.
ssrCode Secondary Surveilence Radar Code

A four-digit octal number received from the aircraft transponder when it is interrogated by a secondary surveillance radar (SSR).

flightId IATA based identifier for this flight, usually issued long before the flight actually takes place.

FlightId is normally the concatenation of OperatingAirlineIATA, FlightNumber and OperationalSuffix.

FlightId typically identifies a flight to the majority of systems, but it is not unique across time. It's unique only in conjunction with FlightDepartureDate.

Exception: Some airlines use their ICAO code (OperatingAirlineICAO) instead of OperatingAirlineIATA. This might be because they aren't an IATA member or because they just prefer the ICAO code. Regardless, this means that it is allowed to use OperatingAirlineICAO as part of FlightId.

FlightId is then defined as the concatenation of AirlineIATAorICAO, FlightNumber and OperationalSuffix.

flightDepartureDate

The scheduled date (based on UTC) of departure of flight. For flights with multiple legs this is the departure of the first leg. This date must not change once set as it is used to make the FlightIds unique.
departureAirportIATA Departure airport IATA code (see AirportIATA for description of term).
arrivalAirportIATA Arrival airport IATA code (see AirportIATA for description of term).
departureAirportICAO Departure airport ICAO code (see AirportICAO for description of term).
arrivalAirportICAO Arrival airport ICAO code (see AirportICAO for description of term).

3.4. GetHeliDataOutboundResponse

 
responseStatus: ResponseStatus See definition under entities.
heliDataOutboundList: HeliDataOutbound See definition under entities.

3.5. HeliDataInbound

 
flightLegIdentifier See entity definition above.
heliFightData See entity definition below.
arrivalDelay

See entity definition above.

A Delay related to an arrival.

sibt Scheduled In-Block Time. The time that an aircraft is scheduled to arrive at its first parking position. Always UTC time.
eibt Estimated In-Block Time. The estimated time that an aircraft will arrive in-blocks. (Equivalent to Airline/Handler ETA –Estimated Time of Arrival). Always UTC time.
aibt Actual In-Block Time. The time that an aircraft arrives in-blocks. (Equivalent to Airline/Handler ATA –Actual Time of Arrival, ACARS = IN). Always UTC time.
eldt Estimated Landing Time. The estimated time that an aircraft will touchdown on the runway. (Equivalent to ATC ETA–Estimated Time of Arrival = landing). Always UTC time.
aldt Actual Landing Time. The time that an aircraft lands on a runway. (Equivalent to ATC ATA –Actual Time of Arrival = landing, ACARS=ON). Always UTC time.
mailWeightUnloaded Weight in Kilos of mail unloaded off the aircraft.
cargoWeightUnloaded Weight in Kilos of cargo (freight) unloaded off the aircraft at the current airport.
paxDisembarking The number of passengers and passive crew disembarking the plane, infants excluded.
PaxDisembarking = PaxAdultDisembarking + PaxChildDisembarking

3.6. HeliDataOutbound

 
flightLegIdentifier  See entity definition above.
heliFightData See entity definition below.
departureDelay

See entity definition above.

A Delay related to a departure.

sobt Scheduled Off-Block Time. The time that an aircraft is scheduled to depart from its parking position. Always UTC time.
tobt Target Off-Block Time. The time that an Aircraft Operator or Ground Handler estimates that an aircraft will be ready, all doors closed, boarding bridge removed, push back vehicle available and ready to start up / push back immediately upon reception of clearance from the TWR. Always UTC time.
eobt Estimated Off-Block Time. The estimated time at which the aircraft will start movement associated with departure. Always UTC time.
aobt Actual Off-Block Time. Time the aircraft pushes back / vacates the parking position. (Equivalent to Airline / Handlers ATD – Actual Time of Departure & ACARS=OUT). Always UTC time.
etot Estimated Take Off Time. The estimated take off time taking into account the EOBT plus EXOT. Always UTC time.
atot Actual Take Off Time. The time that an aircraft takes off from the runway. (Equivalent to ATC ATD–Actual Time of Departure, ACARS = OFF). Always UTC time.
mailWeightLoaded Weight in Kilos of mail loaded onto the aircraft.
cargoWeightLoaded Weight in Kilos of cargo (freight) loaded onto the aircraft at the current airport.
paxBoarding The number of "seated passengers" boarding the aircraft, infants excluded.
PaxBoarding = PaxAdultBoarding + PaxChildBoarding 

3.7. HeliFlightData

 
operatingAirlineICAO The ICAO code of the airline operating the flight.  See AirlineICAO for definition of term.
flightServiceTypeIATA IATA SSIM Appendix C Service Types.
flightServiceTypeExtended Installation/customer specific set of flight service types. Typically used when the defined set in FlightServiceType isn't specific enough. Encoded as integer to clearly separate it from FlightServiceType.
flightIsCancelled Set to true if the flight operation is cancelled. For flight as with code share it's possible to only cancel the code shared flight.
flightRouteOperator The party operating the flight route. This will often be a company that has hired the airline to operate a given route.
flightRouteICAO List of airports a multi leg flight will land on before arriving at the destination. The list consists of AirportICAO codes. The list should contain all airports including first departure airport and last destination airport. The list should be ordered by the actual sequence the aircraft uses the airports.
aircraftICAOType 3-4 character code as designated by International Civil Aviation Organisation (ICAO) to uniquely designate Aircraft Type. Local (non-ICAO) codes can be added as required as long as they are unique for aircraft types within the defined context.
Reference Document: ICAO document 8643.
aircraftConfigVersion Detailed information about the aircraft configuration, received in the aircraft_conf_version field in the ASM and SSM IATA messages.
aircraftTailNumber Tail number painted on the tail used by some carriers as an aircraft identifier. Often the last 3 characters of AircraftRegistration.

3.8. ResponseStatus

beskrivelse

 
responseStatusCode

ResponseStatusCode indicates if the operation succeeded or failed, and if it failed - why. ResponseStatusText is a textual description of ResponseStatusCode. For all operations the set of response codes must be defined. The actual set is dependent upon the context.

For the operations defined her the following values can be used:

  • "OK": Operation succeded.
  • "ERR01":
  • "ERR02":
  • "":
  • "":
  • "ERR99": Other error. "statusText" should describe the error

 

 

The possible values must be decided and documented as coding progresses.

responseStatusText
A textual description of ResponseStatusCode.

4. XML Usage

4.1. Nil Values in Schema

For any particular data element, there is an important distinction between the following cases:

(a) the element is missing
(b) the element is present but has a 'nil' attribute assigned to it

In the first case, this means that the sender is supplying no information about the element. This would typically be because no information is available, or because there has been no change in the value of the element. A recipient would not be expected to take any action as a result of this. In particular, it would not be expected to clear any existing value.

In the second case, this means that the sender has explicitly cleared the element. As a result of this, a recipient would typically clear any value that it had previously stored for this element.

The following table shows an example sequence of messages, and the expected actions taken by the data recipient. It should be noted, however, that the action is up to the recipient. The message from the sender is a notification, and not a command for the recipient to take action.

Message contents

Expected action by recipient

aircraftRegistration element missing

Does not set or change aircraft registration value

<aircraftRegistration>ABC123</aircraftRegistration>

Sets the value to ABC123

aircraftRegistration element missing

Does not change the value

<aircraftRegistration>

Clears the aircraftRegistration value

Note that the sender should not use blank data elements such as <aircraftRegistration/> or <aircraftRegistration></aircraftRegistration> as these may cause validation errors. For example, if the schema specifies a format or a minimum length for an element, then a zero-length element will be invalid. This problem does not occur if using the nil attribute.

Note - Where a field is defined as mandatory in the schema, it must not contain a nil value.

5. XSD files

 

  • No labels