Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Service Description

 

 



asrv.aero

Baggage Information Exchange Service - BIX

 

 

...

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/webservices/1.

...

1/BIXService

...


Document revisions

Date
Description
Author
2020-03-22First complete version of the documentation




Table of Content Zone
maxLevel2
locationtop



Numbered Headings

Introduction

Overview

This service description defines one service with a set of operations to set baggage oriented data. All baggage related data elements are defined by the ADD.

The service is primarily designed to meet the need of airport partners, but availability is the decision of the service provider.

There are a set of use cases that can be realized using the operations and data available, for example:

      • Set baggage data captured when a bag is checked in, manually or at a self service baggage drop (SBD). The SetBagCheckinData operation is meant to cover this.
      • Set baggage data from a baggage handling system (BHS). The SetBhsEventData suited for this.
      • Set data when a bag tag is scanned at some location, possibly as part of a baggage reconciliation system (BRS). The SetBagScanData cover this.
      • Data about any baggage event can be set using the SetBagEventData operation.

.The  SetBagEventData operation covers data in all the other operations. The reason to have multiple operations is:

      • It makes it simpler for developers as the data model is restricted to what is (readily) available.
      • It makes for more stable data definitions as the restricted entities for baggage related data are expected to change much less frequently than the all inclusive one.

Implementation considerations

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

It is however up to the service provider to decide which data elements to actually update. And as clients vary wildly in their capabilities most elements are optional

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

      • the address of the service.
      • any limitations in the implementation.
      • any limitations on how often a client can use the service.

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 WSDL and 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.

Intended readership

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

Service overview

The figure below shows the available operations on the BaggageInformationExchangeService. The operations are described in detail in Service operations.

Image Modified

Service operations

Include Page
Service operations
Service operations

Data entities

Include Page
Data entities
Data entities

XML Usage

Include Page

FDSCP:

XML Usage

FDSCP:

XML Usage

WSDL and XSDs

 

 

Namespace: http://www.asrv.aero/webservices/1.0/BaggageInformationExchangeService

 

Document revisions

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

 

 

...