BagCheckInData

ADD TermDescription

BagTagNumber

The 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagEventAirportIATA
The AirportIATA code associated with the BagEventLocation where a BagEventCode occurred.
BagEventCode 
Code for an event that happened to a bag (Baggage). Often the event will really be for a BagTag as that is what is scanned, and it is "assumed" that a bag is associated with it. Some events are predefined, see "Legal values" below. Other, system specific, events can be added as needed.
BagEventTimestamp
Timestamp defining when a BagEventCode occurred.
BagEventDescription
Descriptive text for an event (BagEventCode) that happened to a bag (Baggage). The descriptions are system specific, and there can be multiple descriptions for the same BagEventCode.
BagEventLocation
The location where a BagEventCode occurred. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations.
BagDepartureFlightId
The FlightId for the flight the bag is supposed to depart on.
BagNextAirportIATA
The AirportIATA code for the next airport the bag should be sent to.
BagFinalAirportIATA
The AirportIATA code for the final airport the bag should be sent to.
BagPhysicalSee Data entities / BagPhysical for description of entity.
BagPnrCode
The PnrCode associated with a BagTag. This will often be the owner of the bag, but might not be.

 

 

 


BagEvent

ADD TermDescription
BagEventCode Code for an event that happened to a bag (Baggage). Often the event will really be for a BagTag as that is what is scanned, and it is "assumed" that a bag is associated with it. Some events are predefined, see "Legal values" below. Other, system specific, events can be added as needed.
BagEventTimestampTimestamp defining when a BagEventCode occurred.
BagEventDescriptionDescriptive text for an event (BagEventCode) that happened to a bag (Baggage). The descriptions are system specific, and there can be multiple descriptions for the same BagEventCode.
BagEventAirportIATAThe AirportIATA code associated with the BagEventLocation where a BagEventCode occurred.
BagEventLocationThe location where a BagEventCode occurred. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations.
BagEventErrorCodeThe relevant error code for events that indicate some form of failure, for instance BagRejected, BagSecScreenRejected and BagToBhsBinProblem. Having the error code in a separate element makes it easier to process the different errors. Any description of the error should be in BagEventDescription.

 

 

 


BagEventData

ADD TermDescription
BagTagNumberThe 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagEventSee entity BagEvent for more information.
BagPreviousAirportIATAThe AirportIATA code for the airport the bag came from. Not relevant for bags that start their journey on "this" airport.
BagNextAirportIATAThe AirportIATA code for the next airport the bag should be sent to.
BagFinalAirportIATAThe AirportIATA code for the final airport the bag should be sent to.
BagSegmentSee entity BagSegment for more information.
BagDepartureFlightIdThe FlightId for the flight the bag is supposed to depart on.
BagPhysicalSee entity BagPhysical for more information.
BagPnrCodeThe PnrCode associated with a BagTag. This will often be the owner of the bag, but might not be.
BEBFTThe Bag Estimated BHS Finish Time is the DateTimeUTC when the baggage handling system estimates that the bag will be finished and ready for further handling. This will typically be, for baggage handling systems with sorting, when the bag is placed in a bin. This is an estimate for the  BagEventCode "BagToBhsBin". Always UTC.
BagPlannedBinThe bin/location where the bag is planned to be delivered to by the baggage handling system. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations. Use the same values as used by BagEventLocation for the BagToBhsBin event.

BagEventData - all entities


BagImage

ADD TermDescription
MediaTypeMime media type. Values are not strictly defined.
ImageThe image of something. Image format would typically be defined by MediaType. Encoding is base64Binary.

 

 

 


BagLostData

ADD TermDescription

BagTagNumber

The 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagLostIrregularityCode
The BagIrregularityCode associated with the bag being registered as lost.
BagLostAirportIATA
The AirportIATA code where the bag is reported to have been lost.
BagLostDate
The date the bag was lost. Mainly to help make the BagTagNumber unique on the BagLostAirportIATA. Not guaranteed to be correct, best effort value. Always UTC.
BagLostFlightId
The FlightId for the flight where the bag became lost. Not guaranteed to be correct, best effort value.
BagLostAdditionalData

Open ended string containing JSON formatted data. Contains any additional information about the lost bag as name:value pairs. For example:

{
   "CARRIER_CD ": "XX",
   "ROUTING": "PUS/PEK/CPH/OSL"
}

 

 

 


BagPhysical



ADD TermDescription

BagTypeIndicator

Indication if baggage contains special goods.

BagSizeIndicator

Indication if baggage is unconventional size or weight.
BagWeightThe weight (in kilos) of one bag.
BagLengthThe length (in Centimeter) of one bag.
BagWidthThe width (in Centimeter) of one bag.
BagHeightThe height (in Centimeter) of one bag.
BagImageEntity


BagScanData

ADD TermDescription

BagTagNumber

The 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagEventAirportIATAThe AirportIATA code associated with the BagEventLocation where a BagEventCode occurred.
BagEventCode Code for an event that happened to a bag (Baggage). Often the event will really be for a BagTag as that is what is scanned, and it is "assumed" that a bag is associated with it. Some events are predefined, see "Legal values" below. Other, system specific, events can be added as needed.
BagEventTimestampTimestamp defining when a BagEventCode occurred.
BagEventDescriptionDescriptive text for an event (BagEventCode) that happened to a bag (Baggage). The descriptions are system specific, and there can be multiple descriptions for the same BagEventCode.
BagEventLocationThe location where a BagEventCode occurred. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations.


BhsEventData



ADD TermDescription

BagTagNumber

The 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagEventAirportIATAThe AirportIATA code associated with the BagEventLocation where a BagEventCode occurred.
BagEventCode Code for an event that happened to a bag (Baggage). Often the event will really be for a BagTag as that is what is scanned, and it is "assumed" that a bag is associated with it. Some events are predefined, see "Legal values" below. Other, system specific, events can be added as needed.
BagEventTimestampTimestamp defining when a BagEventCode occurred.
BagEventDescriptionDescriptive text for an event (BagEventCode) that happened to a bag (Baggage). The descriptions are system specific, and there can be multiple descriptions for the same BagEventCode.
BagEventLocationThe location where a BagEventCode occurred. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations.
BagDepartureFlightIdThe FlightId for the flight the bag is supposed to depart on.
BagNextAirportIATAThe AirportIATA code for the next airport the bag should be sent to.
BagFinalAirportIATAThe AirportIATA code for the final airport the bag should be sent to.
BagSegmentSee BagSegment for description.
BEBFTThe Bag Estimated BHS Finish Time is the DateTimeUTC when the baggage handling system estimates that the bag will be finished and ready for further handling. This will typically be, for baggage handling systems with sorting, when the bag is placed in a bin. This is an estimate for the  BagEventCode "BagToBhsBin". Always UTC.
BagPlannedBinThe bin/location where the bag is planned to be delivered to by the baggage handling system. The location is identified with a text string that is meaningful in the context it is used. The way/codes to identify a location will typically vary across the different implementations. Use the same values as used by BagEventLocation for the BagToBhsBin event.


BimData


ADD TermDescription

BagTagNumber

If known, the bag tag associated with the BIM.
The 10 digit bag tag (licence plate) number as defined by IATA. The BagTagNumber is a concatenation of BagTagLeadingDigit, BagTagIssuerCode and BagTagSerialNumber.
BagEventAirportIATA
If known, or relevant, the airport the BIM relates to.
The AirportIATA code associated with the BagEventLocation where a BagEventCode occurred.
BagInfMsg
A standard IATA baggage information message as a text string. Start and end token ("BSM"/ENDBSM, BPM/ENDBPM, ....") included.

 

 

 


FlightBinData

ADD TermDescription
FlightId

The FlightId of the departing flight - for which bin information is provided below.

FlightDepartureDate

If known, the FlightDepartureDate for the departing flight. If not known the bin information is assumed to be for the first upcoming flight with the given FlightId.


The scheduled date (based on UTC) of departure of flight. For flights with multiple legs this is the departure of the first leg. This date must not change once set as it is used to make the FlightIds unique.

DepartureAirportIATAIdentifies the airport the flight is departing from, and where the bins are.



FlightBin
BinA baggage bin that has been allocated to the flight.
BinSegregationCode

Code/string defining which baggage segregation that are associated with the relevant Bin. Codes are system/handler specific.


ResponseStatus

statusCode : ResponseStatusCode

ResponseStatusCode indicates if the operation succeeded or failed, and if it failed - why. ResponseStatusText is a textual description of ResponseStatusCode. For all operations the set of response codes must be defined. The actual set is dependent upon the context.

  • "OK": Operation succeded.
  • "ERR01":
  • "ERR02":
  • "":
  • "":
  • "ERR99": Other error. "statusText" should describe the error.

Status codes must be documented by the service implementation.

statusText : ResponseStatusText
A textual description of ResponseStatusCode.


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

  • No labels