Jan Jansen

Jan Jansen

Jan.Jansen@vanderlande-logistics.com
Jan Jansen
  • Jan.Jansen@vanderlande-logistics.com
  • Logout
Tenant
API docs by Redocly

Datahub API (6.6.0)

Download OpenAPI specification:

Vanderlande Logistics GmbH: info.digital@vanderlande-logistics.com URL: https://www.vanderlande.com License: Property of Vanderlande Logistics GmbH

OpenAir Datahub acts as a central data repository for all functions, which affect the efficient functioning of an airport. Data can be ingested from various sources via standardized interfaces. The way of getting data out of it is similar; there are standardized REST and MQTT interfaces to fetch the data. The data structure is based on industry standards such as IATA's AIDM and ACI's ACRIS combined with decades of Vanderlande Logistics industry knowledge.

Bag Tag Store

Post a bag tracking event.

Transfers a bag tracking event to ADH. This may change the state of the bag tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Post a bag screening event.

Transfers a bag screening event to ADH. This may change the state of the bag tag.New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

DEPRECATED! Post a bag load into uld event. Deprecated

Transfers a bag load into uld event to ADH. This may change the state of the bag tag.New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Post a bag containerization event.

Transfers a bag containerization event to ADH. This may change the state of the bag tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Post a bag check in event.

Transfers a bag check in event to ADH. This may change the state of the bag tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Post a bag change event.

Transfers a bag change event to ADH. This may change the state of the bag tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Post a bag cancel event.

Transfers a bag cancel event to ADH. This may change the state of the bag tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

bag-id
string

Unique id for the bag. Can be used for an unlimited period of time.

Array of objects (BagTagIdentifier) unique

Additionally identifiers used by BHS etc.

tag
required
string

Tag number of the bag tag. Latest tag number in case of re-tagging. Must not start or end with space.

Array of objects (BagSegment)

Previous segments.

object (BagSegment)

Inbound segment.

object (BagSegment)

Outbound segment.

Array of objects (BagSegment)

Onward segments.

bag-type
string

Bag type identifier.

object (Passenger)

Passenger information for the bag.

sourceId
string
adhId
string
correlationId
string
passenger-status
string

Passenger Status

direction
string
Enum: "INBOUND" "OUTBOUND" "TRANSFER"

The direction of the bag.

tracking-point-type
required
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "ULD_SECURE_STORE_IN" "ULD_SECURE_STORE_OUT" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED" "PROBLEM_AREA_DISCHARGE" "DEPARTED_FROM_PROBLEM_AREA"

Type of tracking point. Depending on the type use either outbound-segment(BHS_INDUCTION, ATR, MES, BVS, EBS_IN, EBS_OUT, MUP_DISCHARGE, RECONCILED, CART_LOAD, LOAD, DEPARTED_FROM_MUP, ARRIVED_AT_BAY, ULD_SECURE_STORE_IN, ULD_SECURE_STORE_OUT)or inbound-segment(ATR, DEPARTED_FROM_BAY, ARRIVED_AT_TRANSFER_LATERAL, ARRIVED_AT_RECLAIM_BELT, UNLOAD, ULD_UNLOAD, RECLAIM_BELT_INDUCTION, DELIVERED, PROBLEM_AREA_DISCHARGE, DEPARTED_FROM_PROBLEM_AREA), never fill both.

tracking-state
string
Enum: "SUCCESS" "NO_READ" "TRACKING_LOST" "MULTIPLE_READ" "NO_BSM" "SEND_TO_PROBLEM"

State of tracking.

transport-state
string

State of transport within BHS.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "BagTrackingEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "bag-id": "EK0123-20250212-HKG-DXB-0123456789",
  • "secondary-identifiers": [
    ],
  • "tag": "Tag1234",
  • "previous-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "onward-segments": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "passenger-status": "string",
  • "direction": "INBOUND",
  • "bag-segments": [
    ],
  • "authorized-to-load": true,
  • "authorized-to-transport": false,
  • "exception": "GATE;",
  • "tracking-point-type": "BHS_INDUCTION",
  • "tracking-state": "SUCCESS",
  • "transport-state": "string"
}

Query bag tag by unique bag-tag-id provided by adh.

Authorizations:
None
path Parameters
id
required
string

The unique bag-tag-id provided by adh. Searches for this in bag-tag-id or merged-bag-tag-id.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "bag-tag-id": "ABCD-1234",
  • "merged-bag-tag-id": [
    ],
  • "tag": "B12345678",
  • "secondary-identifiers": [
    ],
  • "bag-type": "Hard Shell",
  • "passenger": {
    },
  • "bag-segments": [
    ],
  • "inbound-segment": {
    },
  • "outbound-segment": {
    },
  • "direction": "INBOUND, OUTBOUND, TRANSFER",
  • "runningAirportIataCode": "string",
  • "onward-segments": [
    ],
  • "previous-segments": [
    ],
  • "bag-risk": {
    },
  • "bag-journey": {
    },
  • "global-state": "ACTIVE"
}

Query bag tags by flight segment for given bag tag id based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
path Parameters
id
required
string

The unique bag-tag-id provided by adh. Searches for this in bag-tag-id or merged-bag-tag-id.

query Parameters
tag
string

The tag number of the bag tag.

carrier
string

The iata code of the operating carrier.

flight-number
string

The (numeric) flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The iata code of an airport as origin airport of a flight leg the bag is booked on.

destination-iata-code
string

The iata code of an airport as destination airport of a flight leg the bag is booked on.

created-from
string

Object creation time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

created-to
string

Object creation time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

updated-from
string

Last object modification time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

updated-to
string

Last object modification time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

secondary-identifier
string

A secondary identifier given to the bag tag.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query bag events for given bag tag id based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
path Parameters
id
required
string

The unique bag-tag-id provided by adh. Searches for this in bag-tag-id or merged-bag-tag-id.

query Parameters
tag
string

The tag number of the bag tag.

from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

The iata code of the operating carrier.

flight-number
string

The (numeric part of) flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The iata code of the departure airport.

destination-iata-code
string

The iata code of the arrival airport.

event-type
string
Enum: "BAG_CHECK_IN_EVENT" "BAG_CANCEL_EVENT" "BAG_CHANGE_EVENT" "BAG_ROUTE_EVENT" "BAG_REFLIGHT_EVENT" "BAG_CONTAINERIZATION_EVENT" "BAG_TRACKING_EVENT" "BAG_SCREENING_EVENT" "BAG_LOAD_INTO_ULD_EVENT"

The event type.

tracking-event-sub-type
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED"

The tracking event sub-type.

secondary-identifier
string

A secondary identifier given to the bag tag.

container-tag
string

Tag of the a container to search for.

location
string

Location of the container event to search for.

source
string

Source of the container event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query bag tags by flight segment based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
tag
string

The tag number of the bag tag.

carrier
string

The iata code of the operating carrier.

flight-number
string

The (numeric) flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight.

origin-iata-code
string

The iata code of an airport as origin airport of a flight leg the bag is booked on.

destination-iata-code
string

The iata code of an airport as destination airport of a flight leg the bag is booked on.

created-from
string

Object creation time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

created-to
string

Object creation time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

updated-from
string

Last object modification time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

updated-to
string

Last object modification time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

secondary-identifier
string

A secondary identifier given to the bag tag.

bag-tag-id
string

The unique bag-tag-id provided by adh. Looked up in bag-tag-id and merged-bag-tag-id.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query bag events based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
tag
string

The tag number of the bag tag.

from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T13:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

The iata code of the operating carrier.

flight-number
string

The (numeric part of) flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The iata code of the departure airport.

destination-iata-code
string

The iata code of the arrival airport.

event-type
string
Enum: "BAG_CHECK_IN_EVENT" "BAG_CANCEL_EVENT" "BAG_CHANGE_EVENT" "BAG_ROUTE_EVENT" "BAG_REFLIGHT_EVENT" "BAG_CONTAINERIZATION_EVENT" "BAG_TRACKING_EVENT" "BAG_SCREENING_EVENT" "BAG_LOAD_INTO_ULD_EVENT"

The event type.

tracking-event-sub-type
string
Enum: "BHS_INDUCTION" "ATR" "MES" "BVS" "EBS_IN" "EBS_OUT" "MUP_DISCHARGE" "RECONCILED" "CART_LOAD" "LOAD" "DEPARTED_FROM_MUP" "ARRIVED_AT_BAY" "DEPARTED_FROM_BAY" "ARRIVED_AT_TRANSFER_LATERAL" "ARRIVED_AT_RECLAIM_BELT" "UNLOAD" "ULD_UNLOAD" "RECLAIM_BELT_INDUCTION" "DELIVERED"

The tracking event sub-type.

secondary-identifier
string

A secondary identifier given to the bag tag.

bag-tag-id
Array of strings

One or more bag-tag-ids. If searching for events of a bagTag pass in bag-tag-id and all merged-bag-tag-id to find all events, even merged ones.

container-tag
string

Tag of the a container to search for.

location
string

Location of the event to search for.

source
string

Source of the event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query bag tags based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
tag
string

The tag number of the bag tag.

carrier
string

The iata code of the operating carrier. 2-digit code is expected.

flight-number
string

The (numeric) flight number of operating airline.

operational-suffix
string

Operational suffix of flight segment. Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight.

origin-iata-code
string

The iata code of an airport as origin airport of a flight leg the bag is booked on.

destination-iata-code
string

The iata code of an airport as destination airport of a flight leg the bag is booked on.

created-from
string

Object creation time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

created-to
string

Object creation time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

updated-from
string

Last object modification time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

updated-to
string

Last object modification time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

secondary-identifier
string

A secondary identifier given to the bag tag.

bag-tag-id
string

The unique bag-tag-id provided by adh. Looked up in bag-tag-id and merged-bag-tag-id.

container-tag
string

The container tag that was submitted in containerization events.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Container Tag Store

Post a container storage event.

Transfers a container storage event to ADH. This may change the state of the container tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

container-id
string

Unique id for the container. Can be used for an unlimited period of time.

tag
required
string

Tag number of the container for the current journey/usage .

Array of objects (SecondaryIdentifier) unique

Additionally identifiers for the container journey/usage used by airports etc.

required
Array of objects (ContainerEventSegment)

Flight segment(s) for which the event occurred.

required
object

Container activity for which the event occurred. Using different subtypes depending on event-type.

adh-id
string

Unique event id within ADH.

correlation-id
string

The global id which identifies this object across multiple applications.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "ContainerStorageEvent",
  • "container-id": "string",
  • "tag": "AKE12345678",
  • "secondary-identifiers": [
    ],
  • "segments": [
    ],
  • "activity": {
    },
  • "adh-id": "string",
  • "correlation-id": "string"
}

Post a container security event.

Transfers a container security event to ADH. This may change the state of the container tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

container-id
string

Unique id for the container. Can be used for an unlimited period of time.

tag
required
string

Tag number of the container for the current journey/usage .

Array of objects (SecondaryIdentifier) unique

Additionally identifiers for the container journey/usage used by airports etc.

required
Array of objects (ContainerEventSegment)

Flight segment(s) for which the event occurred.

required
object

Container activity for which the event occurred. Using different subtypes depending on event-type.

adh-id
string

Unique event id within ADH.

correlation-id
string

The global id which identifies this object across multiple applications.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "ContainerStorageEvent",
  • "container-id": "string",
  • "tag": "AKE12345678",
  • "secondary-identifiers": [
    ],
  • "segments": [
    ],
  • "activity": {
    },
  • "adh-id": "string",
  • "correlation-id": "string"
}

Post a container registration event.

Transfers a container registration event to ADH. This may change the state of the container tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

container-id
string

Unique id for the container. Can be used for an unlimited period of time.

tag
required
string

Tag number of the container for the current journey/usage .

Array of objects (SecondaryIdentifier) unique

Additionally identifiers for the container journey/usage used by airports etc.

required
Array of objects (ContainerEventSegment)

Flight segment(s) for which the event occurred.

required
object

Container activity for which the event occurred. Using different subtypes depending on event-type.

adh-id
string

Unique event id within ADH.

correlation-id
string

The global id which identifies this object across multiple applications.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "ContainerStorageEvent",
  • "container-id": "string",
  • "tag": "AKE12345678",
  • "secondary-identifiers": [
    ],
  • "segments": [
    ],
  • "activity": {
    },
  • "adh-id": "string",
  • "correlation-id": "string"
}

Post a container movement event.

Transfers a container movement event to ADH. This may change the state of the container tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

container-id
string

Unique id for the container. Can be used for an unlimited period of time.

tag
required
string

Tag number of the container for the current journey/usage .

Array of objects (SecondaryIdentifier) unique

Additionally identifiers for the container journey/usage used by airports etc.

required
Array of objects (ContainerEventSegment)

Flight segment(s) for which the event occurred.

required
object

Container activity for which the event occurred. Using different subtypes depending on event-type.

adh-id
string

Unique event id within ADH.

correlation-id
string

The global id which identifies this object across multiple applications.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "ContainerStorageEvent",
  • "container-id": "string",
  • "tag": "AKE12345678",
  • "secondary-identifiers": [
    ],
  • "segments": [
    ],
  • "activity": {
    },
  • "adh-id": "string",
  • "correlation-id": "string"
}

Post a container containerization event.

Transfers a container containerization event to ADH. This may change the state of the container tag. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

container-id
string

Unique id for the container. Can be used for an unlimited period of time.

tag
required
string

Tag number of the container for the current journey/usage .

Array of objects (SecondaryIdentifier) unique

Additionally identifiers for the container journey/usage used by airports etc.

required
Array of objects (ContainerEventSegment)

Flight segment(s) for which the event occurred.

required
object

Container activity for which the event occurred. Using different subtypes depending on event-type.

adh-id
string

Unique event id within ADH.

correlation-id
string

The global id which identifies this object across multiple applications.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "ContainerStorageEvent",
  • "container-id": "string",
  • "tag": "AKE12345678",
  • "secondary-identifiers": [
    ],
  • "segments": [
    ],
  • "activity": {
    },
  • "adh-id": "string",
  • "correlation-id": "string"
}

Query container tag by unique container-tag-id provided by adh.

In case of merged container tags, the container-tag where it is merged to is returned.

Authorizations:
None
path Parameters
id
required
string

The unique container tag-id provided by adh.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "tag-id": "string",
  • "tag": "string",
  • "secondary-identifiers": [
    ],
  • "container-type": "ULD",
  • "container-subtype": "AKE",
  • "segments": [
    ]
}

Query container events based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
path Parameters
id
required
string

The unique container tag-id provided by adh.

query Parameters
tag
string

The tag number of the container tag.

from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA code of the operating carrierv.

flight-number
string

The (numeric part of) flight number of operating airlinev.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of the departure airport.

destination-iata-code
string

The IATA code of the arrival airport.

event-type
string
Enum: "CONTAINERIZATION" "MOVEMENT" "REGISTRATION" "SECURITY" "STORAGE"

The event type:

event-function
string
Enum: "LOAD" "OFFLOAD" "REMOVE" "ACQUIRE" "TRACK" "DELIVER" "REGISTER" "SCREEN" "CLOSE" "OPEN" "SEAL" "UNSEAL" "RECEIPT" "PUT_AWAY" "WITHDRAW"

The event function:

secondary-identifier
string

A secondary identifier given to the container tag.

location
string

Location of the event to search for.

source
string

Source of the event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query container events based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
tag
string

The tag number of the container tag.

from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA code of the operating carrier.

Flight-number
string

The (numeric part of) flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective Origin Stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of the departure airport.

destination-iata-code
string

The IATA code of the arrival airport.

event-type
string
Enum: "CONTAINERIZATION" "MOVEMENT" "REGISTRATION" "SECURITY" "STORAGE"

The event type:

event-function
string
Enum: "LOAD" "OFFLOAD" "REMOVE" "ACQUIRE" "TRACK" "DELIVER" "REGISTER" "SCREEN" "CLOSE" "OPEN" "SEAL" "UNSEAL" "RECEIPT" "PUT_AWAY" "WITHDRAW"

The event function:

secondary-identifier
string

A secondary identifier given to the container tag.

tag-id
Array of strings

One or more container-tag-ids. If searching for events of a containerTag pass in container-tag-id and all merged-container-tag-id to find all events, even merged ones.

location
string

Location of the event to search for.

source
string

Source of the event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query container tags based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
tag
string

The tag number of the container tag.

carrier
string

Iata code of the operating carrier. 2-digit code is expected.

flight-number
string

The (numeric) flight number of operating airline.

operational-suffix
string

Operational suffix of flight segment. Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight.

origin-iata-code
string

The iata code of an airport as origin airport of a flight leg the container is booked on.

destination-iata-code
string

The iata code of an airport as destination airport of a flight leg the container is booked on.

created-from
string

Object creation time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

created-to
string

Object creation time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

updated-from
string

Last object modification time by ADH: the start point of the interval in UTC (included). e.g. 2020-01-31T12:30:00.000Z.

updated-to
string

Last object modification time by ADH: the end point of the interval in UTC (excluded). e.g. 2020-01-31T12:30:00.000Z.

secondary-identifier
string

A secondary identifier given to the container tag.

tag-id
string

The unique tag-id provided by adh.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Flight Leg Store

Post a flight time event.

Transfers a flight time event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a flight scheduled event.

Transfers a flight scheduled event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a gate resource event.

Transfers a gate resource event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a flight pax count event.

Transfers a pax count event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a check-in desks resource event.

Transfers a check-in desks resource event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a flight cancelled event.

Transfers a flight cancelled event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a terminal resource event.

Transfers a terminal resource event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post an aircraft parking position resource event.

Transfers an aircraft parking position resource event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Post a flight aircraft allocation event.

Transfers a flight aircraft allocation event to ADH. This may change the state of the flight leg. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

identifier-string
string
Deprecated

Flight leg identifier as string. Deprecated, use identifier-string from identifier instead.

flight-id
string

Unique identifier for the flight.

flight-state
string
Enum: "SCHEDULED" "CANCELLED" "OFF_BLOCK" "DEPARTED" "LANDED" "IN_BLOCK"

The current state of the flight.

sourceId
string
adhId
string
correlationId
string
Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

required
Array of objects (FlightTime)

List of flight times to set or update.

departure-or-arrival
required
string
Enum: "DEPARTURE" "ARRIVAL"

Indicator for departure or arrival related information.

Responses

Request samples

Content type
application/json
Example
{
  • "event-type": "FlightTimeEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "identifier-string": "string",
  • "flight-id": "string",
  • "flight-state": "SCHEDULED",
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "secondary-identifiers": [
    ],
  • "sobt": "2019-08-24T14:15:22Z",
  • "sibt": "2019-08-24T14:15:22Z",
  • "aircraft-type": "A320",
  • "aircraft-registration": "string",
  • "is-international": true,
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "via-segments": [
    ],
  • "check-in-desks": "Check-in desk 11, Check-in desk 12",
  • "aircraft-parking-position": "Bay 15",
  • "terminal": "Terminal A",
  • "departure-or-arrival": "DEPARTURE",
  • "baggage-claim-units": [
    ],
  • "flight-times": [
    ]
}

Get flight leg by id.

Authorizations:
None
path Parameters
id
required
string

The flight leg id.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "id": "string",
  • "identifier-string": "string",
  • "identifier": {
    },
  • "secondary-identifiers": [
    ],
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "outbound-resources": {
    },
  • "inbound-resources": {
    },
  • "milestones": {
    },
  • "aircraft": {
    },
  • "is-international": true,
  • "state": "SCHEDULED",
  • "flight-pax": {
    },
  • "via-segments": [
    ]
}

Get events for a specific flight leg.

Return empty result if there are no events for the specified flight leg. If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
path Parameters
id
required
string

The FlightLeg id.

query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

event-type
string
Enum: "FLIGHT_SCHEDULED_EVENT" "AIRCRAFT_ALLOCATION_EVENT" "FLIGHT_TIME_EVENT" "FLIGHT_CANCELLED_EVENT" "GATE_RESOURCE_EVENT" "AIRCRAFT_PARKING_POSITION_RESOURCE_EVENT" "AIRCRAFT_TERMINAL_RESOURCE_EVENT" "BAGGAGE_MAKE_UP_BELT_RESOURCE_EVENT" "BAGGAGE_TRANSFER_LATERAL_RESOURCE_EVENT" "BAGGAGE_CLAIM_UNIT_RESOURCE_EVENT" "CHECK_IN_DESKS_RESOURCE_EVENT" "FLIGHT_PAX_COUNT_EVENT"

The event type:

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query flight events based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of an airport as origin airport for a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport for a flight leg.

event-type
string
Enum: "FLIGHT_SCHEDULED_EVENT" "AIRCRAFT_ALLOCATION_EVENT" "FLIGHT_TIME_EVENT" "FLIGHT_CANCELLED_EVENT" "GATE_RESOURCE_EVENT" "AIRCRAFT_PARKING_POSITION_RESOURCE_EVENT" "AIRCRAFT_TERMINAL_RESOURCE_EVENT" "BAGGAGE_MAKE_UP_BELT_RESOURCE_EVENT" "BAGGAGE_TRANSFER_LATERAL_RESOURCE_EVENT" "BAGGAGE_CLAIM_UNIT_RESOURCE_EVENT" "CHECK_IN_DESKS_RESOURCE_EVENT" "FLIGHT_PAX_COUNT_EVENT"

The event type:

location
string

Location of the event to search for.

source
string

Source of the event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Query flight legs based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight.

origin-iata-code
string

The IATA code of an airport as origin airport of a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport of a flight leg.

from
string

The (included) start point of the interval in UTC for the scheduled departure/ arrival time depending on values for origin/ destination airport. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The (excluded) end point of the interval in UTC for the scheduled departure/ arrival time depending on values for origin/ destination airport. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pax Store

Post a Pax Count event.

Transfers a pax count event to ADH. This will create and send flight pax count event to flight event border. New data is processed asynchronously and may need some time to be updated.

Authorizations:
None
Request Body schema: application/json
required
event-type
required
string

Type of event, must match the type defined for the concrete subclass.

event-time
required
string <date-time>

Timestamp when the event occurred in UTC.

location
string

Location id where the event occured.

source
required
string

System generating the event.

required
object (FlightIdentifier)

identifying properties of flight leg. Additional constraints apply: The event-time must be in the range of 180 days before and 180 days after origin-date

Array of objects (SecondaryIdentifier) unique

Additionally identifiers used by BHS etc.

sourceId
string
adhId
string
correlationId
string
required
object (FlightPax)

Set of passengers and bags count.

Responses

Request samples

Content type
application/json
{
  • "event-type": "PaxCountEvent",
  • "event-time": "2019-08-24T14:15:22Z",
  • "location": "TRA_12",
  • "source": "Scanner TRA_12",
  • "identifier": {
    },
  • "secondary-identifiers": [
    ],
  • "sourceId": "string",
  • "adhId": "string",
  • "correlationId": "string",
  • "flight-pax": {
    }
}

Query flight events based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of an airport as origin airport for a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport for a flight leg.

event-type
string
Value: "PAX_COUNT_EVENT"

The event type:

location
string

Location of the event to search for.

source
string

Source of the event to search for.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Bsm Parser Store

Get parsed BSM's.

Return empty result if there are no BSM. If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of an airport as origin airport for a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport for a flight leg.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a BSM.

Parses a BSM (baggage source message) and generates a bag event. New data is processed asynchronously and may need some time to be updated.

Request Body schema: application/json
required
message
required
string
pipeline
string
payload
required
string

Content of a BSM

correlation-id
string

The global id which identifies this object across multiple applications. If no correlation id is provided, ADH will generate one.

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "pipeline": "string",
  • "payload": "BSM\r\n.V/1XSIN\r\n.I/AI0101/19MAY/BOM/Y\r\n.N/0097883333001\r\nENDBSM",
  • "correlation-id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response samples

Content type
application/json
"string"

This endopint queries BSMs that have been posted to ADH.

Authorizations:
None
path Parameters
id
required
string

UUID that was provided upon creation.

Responses

Response samples

Content type
application/json
{
  • "dimension": {
    },
  • "state": { },
  • "status-indicator": "CHG",
  • "version-data": {
    },
  • "outbound-flight": {
    },
  • "inbound-flight": {
    },
  • "onward-flights": [
    ],
  • "bag-exception-data": "RUSH",
  • "internal-airline-data": "FREE TEXT",
  • "bag-tag": "string",
  • "reconciliation-data": {
    },
  • "security-screening": {
    }
}

Bpm Parser Store

Get parsed BPM's.

Return empty result if there are no BPM. If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of an airport as origin airport for a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport for a flight leg.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a BPM.

Parses a BPM (baggage processed message) and generates a bag event. New data is processed asynchronously and may need some time to be updated.

Request Body schema: application/json
required
message
required
string

Content of a BPM

pipeline
string
correlation-id
string

The global id which identifies this object across multiple applications. If no correlation id is provided, ADH will generate one.

Responses

Request samples

Content type
application/json
{
  • "message": "BPM\r\n.V/1LSYD\r\n.J/R/TOSYD//09MAR/195959L/DNATABS//MU\r\n.U/AKE12345AB//M//DXB\r\n.N/0123398891001\r\nENDBPM",
  • "pipeline": "string",
  • "correlation-id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response samples

Content type
application/json
"string"

This endopint queries BPMs that have been posted to ADH.

Authorizations:
None
path Parameters
id
required
string

UUID that was provided upon creation.

Responses

Response samples

Content type
application/json
{
  • "bag-tag": "string",
  • "bag-ids": [
    ],
  • "version-data": {
    },
  • "processing-info": {
    },
  • "outbound-flight": {
    },
  • "loading-data": {
    },
  • "load-sequence-number": 9,
  • "inbound-flight": {
    },
  • "onward-flights": [
    ],
  • "reconciliation-data": {
    },
  • "handling-location": {
    },
  • "bag-dimension-data": {
    },
  • "bag-tag-printer-id": "BACA99",
  • "bag-exception": "RUSH",
  • "internal-airline-data": "SCANNED",
  • "security-screening": {
    }
}

Bum Parser Store

Get parsed BUM's.

Return empty result if there are no BUM. If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

origin-iata-code
string

The IATA code of an airport as origin airport for a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport for a flight leg.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a BUM.

Parses a BUM (baggage processed message) and generates a bag event. New data is processed asynchronously and may need some time to be updated.

Request Body schema: application/json
required
message
required
string

Content of a BUM

pipeline
string
correlation-id
string

The global id which identifies this object across multiple applications. If no correlation id is provided, ADH will generate one.

Responses

Request samples

Content type
application/json
{
  • "message": "BUM\r\n.V/1TDOH\r\n.F/QR0031/18JUL/EDI/Y\r\n.N/0749328870002\r\n.S/N/18H/C/051/051//N/A\r\nENDBUM",
  • "pipeline": "string",
  • "correlation-id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response samples

Content type
application/json
"string"

This endopint queries BUMs that have been posted to ADH.

Authorizations:
None
path Parameters
id
required
string

UUID that was provided upon creation.

Responses

Response samples

Content type
application/json
{
  • "version-data": {
    },
  • "outbound-flight": {
    },
  • "loading-data": {
    },
  • "bag-tag": "string",
  • "inbound-flight": {
    },
  • "onward-flights": [
    ],
  • "load-sequence-number": 9,
  • "reconciliation-data": {
    },
  • "handling-location": {
    },
  • "bag-exception": "RUSH",
  • "internal-airline-data": "SCANNED",
  • "security-screening": {
    }
}

Cpm Parser Store

Get parsed CPM's.

Return empty result if there are no CPM. If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
from
string

The start point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The end point of the interval in UTC. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight. e.g. 2020-01-31T12:30:00.000Z.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post a CPM.

Posting a IATA message CPM - container pallet message.

Request Body schema: application/json
required
message
required
string

Content of a CPM

pipeline
string
correlation-id
string

The global id which identifies this object across multiple applications. If no correlation id is provided, ADH will generate one.

Responses

Request samples

Content type
application/json
{
  • "message": "CPM\nAB1234/12.A7BBG\n-11L/QKE57447QR/CDE/290/C.PLD.RMD",
  • "pipeline": "string",
  • "correlation-id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response samples

Content type
application/json
"string"

This endopint queries CPMs that have been posted to ADH.

Authorizations:
None
path Parameters
id
required
string

UUID that was provided upon creation.

Responses

Response samples

Content type
application/json
{
  • "ulds": [
    ],
  • "bulk": [
    ],
  • "inbound-flight": {
    },
  • "supplementary-info": [
    ],
  • "additional-text": [
    ]
}

Info

Test connection.

A simple method uses to confirm connectivity with Aviation Data Hub API. It returns information with current timestamp.

Authorizations:
None

Responses

Report Flight Store

Get report flight by id.

Authorizations:
None
path Parameters
id
required
string

The flight id.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "id": "string",
  • "identifier-string": "string",
  • "identifier": {
    },
  • "secondary-identifiers": [
    ],
  • "codeshare-strings": [
    ],
  • "codeshares": [
    ],
  • "flight-segments": [
    ],
  • "outbound-resources": {
    },
  • "inbound-resources": {
    },
  • "milestones": {
    },
  • "aircraft": {
    },
  • "is-international": true,
  • "state": "SCHEDULED",
  • "flight-pax": {
    },
  • "via-segments": [
    ]
}

Query report flight based on given search criteria.

If no query parameter is set the search will be reduced to the last 24 hours. If no maxResult is set a maximum of 1000 records will be returned.

Authorizations:
None
query Parameters
carrier
string

IATA 2-digit code of the operating carrier.

flight-number
string

The numeric flight number of operating airline.

operational-suffix
string

Used to distinguish two flights having the same flight number and departing from their respective origin stations on the same date.

origin-date
string

The day of operation, i.e. local day of schedule off-block time in UTC at first departure airport of flight.

origin-iata-code
string

The IATA code of an airport as origin airport of a flight leg.

destination-iata-code
string

The IATA code of an airport as destination airport of a flight leg.

from
string

The (included) start point of the interval in UTC for the scheduled departure/ arrival time depending on values for origin/ destination airport. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

to
string

The (excluded) end point of the interval in UTC for the scheduled departure/ arrival time depending on values for origin/ destination airport. e.g. 2020-01-31T12:30:00.000Z. If used the from and the to parameter has to be set.

max-results
integer <int32>

The maximum number of results.

Responses

Response samples

Content type
application/json
[
  • {
    }
]