Introduction
The FlightDataSubscriptionService contains operations to subscribe and unsubscribe to flight related data from the service provider, typically an airport or an airport group. All operations follow the same pattern:
SubscribeXXX( ServiceUrl, FlightFilter ): SubscribeResponse
Unsubscribe( SubscriptionId ): ResponseStatus
XXX varies by subscribe operation. The ServiceUrl and FlightFilter are the same for all operations. See "Data definitions" for documentation of FlightFilter and the different return types.
The figure below shows the defined operations.
The party subscribing to data must implement a service (FlightDataNotificationService) and provide the address to the service in "ServiceUrl". The relevant operation on this service will then be called every time new data (matching FlightFilter) is available. The return type (SubscribeResponse) from a subscribe operation contains SubscriptionId, which identifies this subscription to an unsubscribe operation.
If the service defined by ServiceUrl isn't available for some reason an unsubscribe operation will typically be done automatically.
Operations
SubscribeFlightDataInbound
Signature | SubscribeFlightDataInbound( flightDataInboundService: ServiceUrl, flightFilter: FlightFilter ) : SubscribeResponse |
|---|---|
Description | Subscribes to data about the set of inbound flights that fit the FlightFilter. See the data definitions for documentation of parameters and return values. |
UnsubscribeFlightDataInbound
Signature | UnsubscribeFlightDataInbound( subscriptionId : SubscriptionId ) : ResponseStatus |
|---|---|
Description | Unsubscribe cancels the subscription defined by SubscriptionId. The same will typically happen if the service is unavailable. |
SubscribeFlightDataOutbound
Signature | SubscribeFlightDataOutbound( flightDataOutboundService: ServiceUrl, flightFilter: FlightFilter ) : SubscribeResponse |
|---|---|
Description | See SubscribeFlightDataInbound. |
UnsubscribeFlightDataOuitbound
Signature | UnsubscribeFlightDataOutbound( subscriptionId : SubscriptionId ) : ResponseStatus |
|---|---|
Description | See UnsubscribeFlightDataInbound. |
SubscribeFlightLegData
Signature | SubscribeFlightLegData( flightLegDataService: ServiceUrl, flightFilter: FlightFilter ) : SubscribeResponse |
|---|---|
Description | See SubscribeFlightDataInbound. |
UnsubscribeFlightLegData
Signature | UnsubscribeFlightLegData( subscriptionId : SubscriptionId ) : ResponseStatus |
|---|---|
Description | See UnsubscribeFlightDataInbound. |
SubscribeTurnaroundData
Signature | SubscribeTurnaroundData( turnaroundDataServiceService: ServiceUrl, flightFilter: FlightFilter ) : SubscribeResponse |
|---|---|
Description | See SubscribeFlightDataInbound. |
UnsubscribeTurnaroundData
Signature | UnsubscribeTurnaroundData( subscriptionId : SubscriptionId ) : ResponseStatus |
|---|---|
Description | See UnsubscribeFlightDataInbound. |
SubscribeAlerts
Signature | SubscribeAlerts( alertService: ServiceUrl, flightFilter: FlightFilter ) : SubscribeResponse |
|---|---|
Description | See SubscribeFlightDataInbound. |
UnsubscribeAlerts
Signature | UnsubscribeAlerts( subscriptionId : SubscriptionId ) : ResponseStatus |
|---|---|
Description | See UnsubscribeFlightDataInbound. |