Service Description



asrv.aero

Bag Data Submit Service v 1.0



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




Document revisions


1. Service facts

2. Introduction

2.1. Overview

This service defines a set of operations designed to submit bag oriented data. The set of operations available is expected to grow over time.

The service is designed to be implemented by airports.

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 Bag Data Submit Service version 1.0 will typically be asynchronously processed. This means that all data that follows the syntax will be accepted, but it might not be used by downstream systems.

The figure below visualizes the defined operations.


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. SubmitBatchData( BatchEventDataIn )

Submits data related to a batch of bags, typically meant for an ULD (Unit Load Device).

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

3.3.2. SubmitBhsEventData( BhsEventDataIn )

Submits bag event data from a baggage handling system (BHS) ( BhsEventData ). This is data related to one bag, with BagTagNumber as the key. The BHS should call this operation for all significant bag events. See BagEventCode for a list of relevant events.

Only BagTagNumber and the BagEvent are required. Other elements should be sent when the BHS knows them.

If the bag is part of a batch, BhsBatchId links the bag to that batch. The batch information itself is submitted with SubmitBatchData.

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

3.3.3. SubmitLostBagData( LostBagDataIn )

Submits information about a lost bag (LostBagData). This is data related to one bag, reported by an airline or handler from their baggage tracing system (e.g. WorldTracer). Since BagTagNumber isn't unique across airports and dates additional information (BagLostAirportIATA, BagLostDate) is needed to uniquely identify the bag.

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

4. Data entities

4.1. BagEvent

ADD Term Comments
BagEventCode Required. See the legal values in ADD.
BagEventTimestamp Required. When the event occurred (UTC).
BagEventDescription Free text describing the event.
BagEventAirportIATA Required. The airport where the event occurred.
BagEventLocation Where in the BHS the event occurred, for instance a scanner, screening machine or bin.
BagEventErrorCode Only for events that indicate a failure, for instance BagRejected, BagSecScreenRejected or BagToBhsBinProblem. Any description of the error goes in BagEventDescription.

4.2. BagImage

ADD Term Comments
MediaType Required. For instance image/png or image/jpeg.
Image Required. The image, base64 encoded.

4.3. BagPhysical

ADD Term Comments
BagTypeIndicator Indication if baggage contains special goods.
BagSizeIndicator Indication if baggage is of unconventional size or weight.
BagWeightPrecise Weight in grams.
BagLength In centimetres.
BagWidth In centimetres.
BagHeight In centimetres.
BagImage Zero or more images of the bag, if the BHS has them.

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



BinSegregation

The set of segregations that are in this batch. 

BinSegregationCode

Allowed values based on the value of the bin allocation criteria:

EXCEPTION_TYPE

  • *
  • NONE
  • PRIORITY
  • RUSH
  • CREW
  • VIP
  • UNACCOMPANIED
  • OTHER

NEXT_BAG_DESTINATION

  • <airport>

TRANSFER

  • YES
  • NO
  • *
  • <flight id>
  • <airport>

BAG_CLASS

  • <bag class> (single uppercase character)
  • *

Note that if there are multiple values for the same bin allocation criteria, add multiple BinSegregation elements with the same bin allocation criteria. 

BinAllocationCriteria

Expects one of the following values:

  • EXCEPTION_TYPE
  • NEXT_BAG_DESTINATION
  • TRANSFER
  • BAG_CLASS

4.5. BatchEventDataIn


4.6. BhsEventData

ADD Term Comments
BagTagNumber Required. Identifies the bag. Not unique over time; numbers are reused.
BhsBatchId The batch, if any, this bag belongs to. The batch information itself is submitted with SubmitBatchData.
BagEvent Required. The event that happened to the bag.
BagNextAirportIATA The next airport the bag is sorted for, if known by the BHS.
BagFinalAirportIATA The final airport the bag is sorted for, if known by the BHS.
BagDepartureFlightId The flight the bag is sorted for, if known by the BHS.
BagPhysical Physical properties of the bag, if measured by the BHS.
BEBFT Estimated time for when the BHS expects to have delivered this bag to its final destination in the BHS. This would typically be a bin, a speed loader or a baggage belt.
BagPlannedBin The bin/location the BHS plans to deliver the bag to.

4.7. BhsEventDataIn


4.8. LostBagData



ADD Term Description
BagTagNumber

Mandatory. The original bag tag number of the lost bag.

BagNewTagNumber

The new bag tag number, if the bag has been given a new tag (e.g. a rush tag when it is forwarded).

BagLostReportId

The report number in the tracing system (in WorldTracer, the file number).

BagLostReportingAirportIATA

The station where the lost bag report was created.

BagLostReportingAirlineIATA

The airline that created the lost bag report.

BagLostIrregularityCode

Mandatory. The irregularity code.

BagLostAirportIATA

The station responsible for the bag being lost.

BagLostFlightId

The flight the bag missed at BagLostAirportIATA.

BagLostDate Mandatory. The date (UTC) the bag was lost. If this is not known, use the date of the SOBT (UTC) of the flight the bag was supposed to leave on.
BagLostAdditionalData

Other data from the tracing system, as JSON. See below.



4.8.1. BagLostAdditionalData

BagLostAdditionalData can contain any data from the tracing system that has no element of its own. The content is not validated. For WorldTracer, Avinor recommends sending the CSV columns below that have no element of their own, using the column names as keys and times in UTC (ISO 8601). Example:

{
  "ROUTING": "BCN/OSL/AES",
  "INB_FLT_ID": "DY1741",
  "INB_DATOP": "2017-09-11",
  "INB_STNF": "HAU",
  "INB_DI": "D",
  "INB_STA": "2018-02-12T09:25:00Z",
  "INB_ATA": "2018-02-12T10:19:00Z",
  "OUT_FLT_ID": "DY414",
  "OUT_DATOP": "2017-09-11",
  "OUT_DI": "I",
  "OUT_STD": "2018-02-12T10:40:00Z",
  "OUT_ATD": "2018-02-12T10:53:00Z",
  "TRANSFERTIME_MINS": 34,
  "AC_TYPE_CODE_IATA": "737"
}

Personal data about the passenger (name, address, phone number, e-mail etc.) must not be sent.

Forklaring til kolonner i WorldTracer CSV fil:

WT verdi Krav Beskrivelse Eksempel
ROUTING Ønsket for QA/oppfølging Stasjoner involvert BCN/OSL/AES
INB_DATOP Obligatorisk INNkommende dato 11.09.2017
INB_FLT_ID Obligatorisk INNkommende flight DY1741
INB_DI Valgfri Domestic/International D
INB_STNF Ønsket for QA/oppfølging Forrige destinasjon HAU
INB_STA Obligatorisk Planlagt ankomsttid (SIBT) 12.02.2018 09:25
INB_ATA Valgfri Virkelig ankomsttid (AIBT) 12.02.2018 10:19
OUT_DATOP Obligatorisk Utgående dato 11.09.2017
OUT_FLT_ID Obligatorisk Utgående flight DY414
OUT_DI Valgfri Domestic/International I
OUT_STD Obligatorisk Planlagt avgangstid (SOBT) 12.02.2018 10:40
OUT_ATD Valgfri Virkelig avgangstid (AOBT) 12.02.2018 10:53
TRANSFERTIME_MINS Valgfri Minutter mellom ankomst og avgang som registrert i Worldtracer 34
AC_TYPE_CODE_IATA Valgfri Flytype 737

4.9. LostBagDataIn


4.10. TransData

CorrelationId
Identifier that can be used to correlate messages, transactions, log entries etc. The identifier should be unique across all relevant systems. It is the responsibility of the creator of the message/transaction/log entry/...  to guarantee uniqueness. The CorrelationId can for instance be a GUID, or something shorter based on site specific rules.
SourceOrganization
Name of the organization/company that created the original data. This will typically be an airline company or an handler. The value set are site specific.

In BDSS this can also be the BHS supplier.

SourceSystem
Name of IT system, in the SourceOrganization, that was the source of the data The value set are site specific.
SourceTimestamp
UTC timestamp for when the source was updated. If unknown, use current (UTC) time.

DateTimeUTC
XML dateTime always in UTC. NB! A 'Z' shall always be appended to indicate UTC!


5. Avinor use cases

6. Overview

This section describes how Avinor expect this service to be used with a set of use cases. Other airports might use the service in a different way.

7. Use cases

7.1. Xxx


7.2. Yyy


8. XSDs

File Created Comment

bag_data_submit_service.zip

2026-01-27 14:18  

bag_data_submit_service_1_0.zip

2026-10-08 12:30  


  • No labels