Service Description

asrv.aero

BRS Integration Service v 1.0

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

The service description is a work in progress, and without version control, as long as this note is here.

Document revisions

Date	Description	Author
2023-09-04	First version under version control.	Ole Nymoen

1. Service facts

Name: BrsIntegrationService
Operations, see Service operations.
REST based service. Operations are accessed using HTTPS POST.
Service security: Decided by implementation.
Standard return codes are described here: Service error response

2. Introduction

2.1. Overview

This service defines a set of operations designed to support integration between airports and BRS (Baggage Reconciliation System). At the bag level this service extend the functionality defined in Bag Event Notification Service, and add 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 be implemented by both the relevant airport and the BRS 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 BRS Integration Service v 1.1 submits data that typically 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 operation should be called for for all relevant 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

BagEventDataIn

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. Service error response defies how to get more information about the actual problem.
Other error/warning returns are possible.

3.3.2. SubmitBatchEventData( BatchEventDataIn )

Submits batch event data (BatchEventData).

Parameters

BatchEventDataIn

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. Service error response defies how to get more information about the actual problem.
Other error/warning returns are possible.

4. Data entities

4.1. BagEventData

The event defined with this data set occurs on BagEventAirportIATA. The context is one of the following:

A departing bag from BagEventAirportIATA where any arrival information is unknown. In this case the next airport is given and the relevant flight information.
An arriving bag where any departure information from the BagEventAirportIATA is unknown. In this case the previous airport is given and the relevant flight information.
A transfer bag that arrives on a known flight and departs on a known flight. Both arriving flight and departing flight information is given.

NB! Arriving and departing flight information is optional, but at least one should be available. It is however possible to receive events without any flight information at all.

ADD Term	Description
BagTagNumber	Uniquely identifier for the bag for a period of time. Will be reused.
BhsBatchId	Identifies the BHS-batch this bag is included in - if any.
BagEventAirportIATA	The airport the event occurred on.
BagEventCode
BagEventTimestamp
BagEventDescription
BagEventLocation
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	The bin, if any, the bag should be sent to.

Arriving flight	Information about the flight the bag has arrived on.
BagArrivalFlightDepartureDate	The FlightDepartureDate of the flight the bag arrived on.
BagArrivalFlightId
BagPreviousAirportIATA	The airport the arriving flight leg left from.

Departing flight	Information about the flight the bag is planned to depart on.
BagDepartureFlightDepartureDate	The FlightDepartureDate of the flight the bag is planned to depart on.
BagDepartureFlightId
BagNextAirportIATA
BagFinalAirportIATA

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