Service Description

asrv.aero

Bag Data Submit Service v 1.0

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

Document revisions

Date	Description	Author
	Not under version control yet	Ole Nymoen

1. Service facts

Name: BagDataSubmitService
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 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 submits data will typically be asynchronously processed. This means that all data that follow 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

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.

3.3.2. SubmitLostBagData( LostBagDataIn )

Submits information about a lost bag (LostBagData). This is data related to one bag. Since BagTagNumber isn't unique across airports and dates additional information (BagLostAirportIATA, BagLostDate) is needed to uniquely identify the bag.

Parameters

LostBagDataIn

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. 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.
binSegregation	See below. The set of segregations that are in this batch.
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
BinSegregationCode	Allowed values based on the value of the bin allocation criteria: EXCEPTION_TYPE ANY PRIORITY RUSH CREW * Other NEXT_BAG_DESTINATION <destination airport> * ONWARD_TRANSFER <destination airport> YES NO * TRANSFER_FLIGHT YES NO <flight id> * TRAVEL_CLASS C Y M * Other 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 ONWARD_TRANSFER TRANSFER_FLIGHT TRAVEL_CLASS