Service Description



asrv.aero

BHS Submit Service v 1.0



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



Document revisions

Date

Description

Author

2023-09-04First version under version control.

Ole Nymoen 



1. Service facts

2. Introduction

2.1. Overview

This service description defines one service with a set of operations designed to support the need airports have for bag related information from baggage handling systems (BHS). At the bag level this service slightly extend the functionality in the Baggage Information Exchange Service, and adds functionality for reporting batch oriented events. A "batch" in this regard is a set of bags treated as one "unit" and delivered at some location without any other bags being delivered to the same location. 

The service is designed to meet the need of a BHS provider.

A set of use cases are described here: Avinor use cases

2.2. Implementation considerations

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

It is however up to the service provider which data elements to support.

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

    • the address of the service.
    • any limitations in the implementation.

2.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.

2.4. Intended readership

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

3. Service operations

3.1. Overview

The operations in BHS Submit Service v1.0 submits data that will be asynchronously processed. This means that all data that follow the syntax will be accepted, but it might not be used by downstream systems.

3.2. Service error response

If a service specific error occurs the entity below will be returned. Any service specific errors will be documented with the actual service implementation.
ErrorResponse is typically used with HTTP Response Code: 400 Bad Request

timestamp: TimestampUTC

Timestamp when the error was generated by the service.

A precise time for when something happened. Always UTC.
serviceErrorCode : ServiceErrorCode

An integer code representing a service specific error. The actual values are described in the service definition.

serviceErrorDescription: ServiceErrorDescription

 A textual description of ServiceErrorCode.

3.3. Operations

3.3.1. SubmitBagEventData ( BagEventDataIn )

Submits bag event data ( BagEventData ). This is data related to one bag, and with BagTagNumber as the key. The BHS must call this operation for all significant bag events. See BagEventCode for a list of relevant events.

This operation is an extended version of the Baggage Information Exchange Service.SetBhsEventData operation.

Parameters

Returns

  • 200 OK if everything went well. The data is sent on for further processing.
  • 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
  • Other error/warning returns are possible.

3.3.2. SubmitBaggageData ( BaggageDataIn )

Submits baggage data (BaggageData). This is FlightLeg oriented baggage data the BHS might have. First/last bag and bin data, if relevant, is of particular interest.

This operation is identical to the Flight Data Submit Service v 2.0.SubmitBaggageData operation.

Parameters

Returns

  • 200 OK if everything went well. The data is sent on for further processing.
  • 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
  • Other error/warning returns are possible.

3.3.3. SubmitBatchEventData ( BatchEventDataIn )

Submits batch event data ( BatchEventData ). 

Parameters

Returns

  • 200 OK if everything went well. The data is sent on for further processing.
  • 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
  • Other error/warning returns are possible.

4. Data entities

4.1. BagEventData
ADD Term Description

BagTagNumber
Uniquely identifier for the bag for a period of time. Will be reused.
BhsBatchId The batch, if any, this bag belongs to.
BagEventAirportIATA

BagEventCode 

BagEventTimestamp

BagEventDescription

BagEventLocation

BagDepartureFlightId

BagNextAirportIATA

BagFinalAirportIATA

BEBFT
Estimated time for when the BHS expects to have delivered this bag to it's final, in the BHS setting, destination. This would typically be at a bin, a speed loader or a baggage belt.
BagPlannedBin



BagPhysical

BagTypeIndicator
Indication if baggage contains special goods.

BagSizeIndicator

 Indication if baggage is unconventional size or weight.
BagWeightPrecise


BagImage Used if the BHS can have images of the bag.
MediaType
Image





4.2. BagEventDataIn

TransData

BagEventData


4.3. BaggageData

Identification

If UniqueFlightLegId is included it is used as the only identification element. It must have been received previously by data from the airport system responsible for allocating it, typically an AODB.

Required if UniqueFlightLegId isn't included. Strongly preferred regardless.

Required if UniqueFlightLegId isn't included. Strongly preferred regardless.

Required if UniqueFlightLegId isn't included. Strongly preferred regardless.

Strongly preferred
Strongly preferred
Strongly preferred

BaggageDepartureData 
NILABLE
NILABLE
NILABLE
  • BaggageBinData
 NILABLE



BaggageArrivalData
NILABLE
NILABLE
NILABLE
NILABLE
NILABLE
NILABLE


4.4. BaggageDataIn

TransData

BaggageData


4.5. BatchEventData
ADD Term / Entity Comments
AirportIATA The airport where the baggage handling system is located.
BhsBatchId

Uniquely identifies a batch of bags on the relevant airport, for a given period of time.
BhsBatchEventCode


BhsBatchEventTimestamp
BhsBatchEventDescription 
UniqueFlightLegId Required if available. Identifies the flight leg this batch should depart on.
FlightId Required if available. The flight this batch is to depart on.
FlightDepartureDate Required if available.
ArrivalAirportIATA Required if available. Arrival airport for the flight leg this batch departs on. Might not be the final airport for the batch.
SOBT Required if available.
BinSegregationCode A list of the segregation codes that this batch covers. 
LoadUnitType The load unit type expected to be used for this batch.
LoadUnitId The identifier of the transport unit (typically an ULD) this batch is loaded into. 

BhsBatchBagCount

 The number of bags in the batch.
BagTagNumber A list of the bag tags that has been allocated to this batch.
BhsBatchLoadLocation The location where this batch is planned to be delivered or where it actually is being delivered to.
EstimatedArrAtLocation

Estimate for the arrival of the first bag at the "BhsBatchLoadLocation".

4.6. BatchEventDataIn

TransData

BatchEventData


4.7. TransData
CorrelationId

SourceOrganization

SourceSystem

SourceTimestamp


5. Avinor use cases

6. Overview

This section describes how Avinor plan to use this service from self service bag drop stations. Other airports might use the service in a different way.

7. Use cases

7.1. Use of SubmitBaggageData


7.2. Use of SubmitBagEventData


7.3. Use of SubmitBagEventData and SubmitBatchEventData


8. XSDs

File Created Comment

bhs-submit-service-3.100.1.zip

 2024-02-13 16:02 Remove sourcedata. Define BiaBatchMessage version 1.0 and BiaMessage version 3.0

bhs-submit-service-3.94.0.zip

 2023-05-23 15:26  

bhs-submit-service-3.94.2.zip

 2023-06-20 09:21 Add the missing definitions for BaggageDataIn. New entities: - BaggageArrivalData - BaggageBinData - BaggageData - BaggageDepartureData

bhs-submit-service-3.95.0.zip

 2023-06-28 10:11 Update the TransData definition with a SourceData element


  • No labels