AirOperations

GET /udl/airloadplan/tuple

Changed on May 29, 2025

Service operation to dynamically query data and only return specified columns/fields. Requested columns are specified by the 'columns' query parameter and should be a comma separated list of valid fields for the specified data type. classificationMarking is always returned. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5 hours would return the satNo and period of elsets with an epoch greater than 5 hours ago.

Request

Base URL
https://unifieddatalibrary.com
URL
https://unifieddatalibrary.com/udl/airloadplan/tuple
Auth
none declared

Query parameters

columnsstring required

Comma-separated list of valid field names for this data type to be returned in the response. Only the fields specified will be returned as well as the classification marking of the data, if applicable. See the ‘queryhelp’ operation for a complete list of possible fields.

estDepTimestring date-time required

The current estimated time that the aircraft is planned to depart, in ISO 8601 UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)

firstResultinteger

maxResultsinteger

Response

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

externalIdstring

Optional ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID.

idMissionstring

The UDL ID of the mission this record is associated with.

missionNumberstring

The mission number of the mission supporting this load plan.

idSortiestring

The UDL ID of the aircraft sortie this record is associated with.

legNuminteger

The leg number of the mission supporting this load plan.

callSignstring

The call sign of the mission supporting this load plan.

tailNumberstring

The tail number of the aircraft supporting this load plan.

aircraftMDSstring

The Model Design Series designation of the aircraft supporting this load plan.

depICAOstring

The departure International Civil Organization (ICAO) code of the departure airfield.

depAirfieldstring

Optional identifier of departure airfield with no International Civil Organization (ICAO) code.

estDepTimestring date-time required

The current estimated time that the aircraft is planned to depart, in ISO 8601 UTC format with millisecond precision.

arrICAOstring

The arrival International Civil Organization (ICAO) code of the landing airfield.

arrAirfieldstring

Optional identifier of arrival airfield with no International Civil Organization (ICAO) code.

estArrTimestring date-time

The current estimated time that the aircraft is planned to arrive, in ISO 8601 UTC format with millisecond precision.

crewSizeinteger

The number of crew members on the aircraft.

cargoConfigstring

The cargo configuration required for this leg (e.g. C-1, C-2, C-3, DV-1, DV-2, AE-1, etc.). Configuration meanings are determined by the data source.

equipConfigstring

Description of the equipment configuration (e.g. Standard, Ferry, JBLM, CHS, Combat, etc.). Configuration meanings are determined by the data source.

tankConfigstring

Description of the fuel tank(s) configuration (e.g. ER, NON-ER, etc.). Configuration meanings are determined by the data source.

basicWeightnumber double

The weight of the aircraft without passengers, cargo, equipment, or usable fuel, in kilograms.

basicMomentnumber double

The basic weight of the aircraft multiplied by the distance between the reference datum and the aircraft's center of gravity, in Newton-meters.

fuelWeightnumber double

The weight of usable fuel on board the aircraft, in kilograms.

fuelMomentnumber double

The fuel weight on board the aircraft multiplied by the distance between the reference datum and the fuel's center of gravity, in Newton-meters.

estLandingFuelWeightnumber double

The estimated weight of usable fuel upon landing, in kilograms.

estLandingFuelMomentnumber double

The estimated weight of usable fuel upon landing multiplied by the distance between the reference datum and the fuel's center of gravity, in Newton-meters.

operatingWeightnumber double

The basic weight of the aircraft including passengers and equipment, in kilograms.

operatingMomentnumber double

The operating weight of the aircraft multiplied by the distance between the reference datum and the aircraft's center of gravity, in Newton-meters.

cargoWeightnumber double

The weight of the cargo on board the aircraft, in kilograms.

cargoMomentnumber double

The sum of cargo moments of all cargo on board the aircraft, in Newton-meters. Each individual cargo moment is the weight of the cargo multiplied by the distance between the reference datum and the cargo's center of gravity.

zeroFuelWeightnumber double

The operating weight of the aircraft including cargo, mail, baggage, and passengers, but without usable fuel, in kilograms.

zeroFuelMomentnumber double

The zero fuel weight of the aircraft multiplied by the distance between the reference datum and the aircraft's center of gravity, in Newton-meters.

zeroFuelCGnumber double

The center of gravity of the aircraft using the zero fuel weight and zero fuel total moment, as a percentage of the mean aerodynamic chord (%MAC).

grossWeightnumber double

The total weight of the aircraft at takeoff including passengers, cargo, equipment, and usable fuel, in kilograms.

grossMomentnumber double

The sum of moments of all items making up the gross weight of the aircraft, in Newton-meters.

grossCGnumber double

The center of gravity of the aircraft using the gross weight and gross moment, as a percentage of the mean aerodynamic chord (%MAC).

landingWeightnumber double

The gross weight of the aircraft upon landing, in kilograms.

landingMomentnumber double

The sum of moments of all items making up the gross weight of the aircraft upon landing, in Newton-meters.

landingCGnumber double

The center of gravity of the aircraft using the landing weight and landing moment, as a percentage of the mean aerodynamic chord (%MAC).

seatsOnboardinteger

Number of passenger seats on the aircraft.

seatsReleasedinteger

Number of passenger seats released this leg.

ppOnboardinteger

Number of pallet positions on the aircraft.

ppReleasedinteger

Number of pallet positions released this leg.

aclOnboardnumber double

Allowable Cabin Load (ACL) onboard the aircraft. The maximum weight of passengers, baggage, and cargo that can be safely transported in the aircraft cabin, in kilograms.

aclReleasednumber double

Allowable Cabin Load (ACL) released this leg. The weight of passengers, baggage, and cargo released from the aircraft cabin, in kilograms.

cargoBayFSMinnumber double

Minimum fuselage station (FS) where cargo can be stored. FS is the distance from the reference datum, in meters.

cargoBayFSMaxnumber double

Maximum fuselage station (FS) where cargo can be stored. FS is the distance from the reference datum, in meters.

cargoBayWidthnumber double

Width of the cargo bay, in meters.

cargoVolumenumber double

Volume of cargo space in the aircraft, in cubic meters.

loadmasterNamestring

Name of the loadmaster or boom operator who received the cargo briefing.

loadmasterRankstring

Rank of the loadmaster or boom operator overseeing cargo loading/unloading.

availableTimestring date-time

Time the loadmaster or boom operator is available for cargo loading/unloading, in ISO 8601 UTC format with millisecond precision.

schedTimestring date-time

Time the loadmaster or boom operator is scheduled to begin overseeing cargo loading/unloading, in ISO 8601 UTC format with millisecond precision.

briefTimestring date-time

Time the cargo briefing was given to the loadmaster or boom operator, in ISO 8601 UTC format with millisecond precision.

utilCodestring

Alphanumeric code that describes general cargo-related utilization and characteristics for an itinerary point.

loadRemarksstring

Remarks concerning this load plan.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

updatedAtstring date-time

Time the row was updated in the database, auto-populated by the system.

updatedBystring

Application user who updated the row in the database, auto-populated by the system.

sourceDLstring

The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

Example response

[
  {
    "id": "0457f578-e29c-312e-85aa-0a04a430bdd0",
    "classificationMarking": "U",
    "externalId": "dec7a61a-cd97-4af0-b7bc-f4c3bb33341b",
    "idMission": "412bebb6-a45e-029c-ca51-e29f8a442b12",
    "missionNumber": "AJM123456123",
    "idSortie": "823acfbe6-f36a-157b-ef32-b47c9b589c4",
    "legNum": 200,
    "callSign": "RCH1234",
    "tailNumber": "77187",
    "aircraftMDS": "C17A",
    "depICAO": "KCHS",
    "depAirfield": "W99",
    "estDepTime": "2024-01-01T01:00:00.123Z",
    "arrICAO": "ETAR",
    "arrAirfield": "W99",
    "estArrTime": "2024-01-01T02:00:00.123Z",
    "crewSize": 5,
    "cargoConfig": "C-1",
    "equipConfig": "Standard",
    "tankConfig": "ER",
    "basicWeight": 100.1,
    "basicMoment": 2500.1,
    "fuelWeight": 100.1,
    "fuelMoment": 2500.1,
    "estLandingFuelWeight": 100.1,
    "estLandingFuelMoment": 2500.1,
    "operatingWeight": 100.1,
    "operatingMoment": 2500.1,
    "cargoWeight": 100.1,
    "cargoMoment": 2500.1,
    "zeroFuelWeight": 100.1,
    "zeroFuelMoment": 2500.1,
    "zeroFuelCG": 39.5,
    "grossWeight": 100.1,
    "grossMoment": 2500.1,
    "grossCG": 38.8,
    "landingWeight": 100.1,
    "landingMoment": 2500.1,
    "landingCG": 38.2,
    "seatsOnboard": 20,
    "seatsReleased": 15,
    "ppOnboard": 18,
    "ppReleased": 5,
    "aclOnboard": 500.1,
    "aclReleased": 200.1,
    "cargoBayFSMin": 10.1,
    "cargoBayFSMax": 20.1,
    "cargoBayWidth": 3.1,
    "cargoVolume": 50.1,
    "loadmasterName": "John Smith",
    "loadmasterRank": "Staff Sergeant",
    "availableTime": "2024-01-01T02:00:00.123Z",
    "schedTime": "2024-01-01T02:30:00.123Z",
    "briefTime": "2024-01-01T01:00:00.123Z",
    "utilCode": "AD",
    "loadRemarks": "Load remarks",
    "airLoadPlanULNActuals": [
      {
        "onloadId": 200,
        "onloadLOCode": "KCHS",
        "offloadId": 300,
        "offloadLOCode": "KHOP",
        "uln": "T01ME01",
        "projName": "CENTINTRA21",
        "oplan": "5027A",
        "numPax": 44,
        "numLitter": 10,
        "numAmbulatory": 10,
        "numAttendant": 10,
        "ulnCargoWeight": 1000.1,
        "ulnRemarks": "ULN actuals remark"
      }
    ],
    "airLoadPlanHazmatActuals": [
      {
        "itemName": "NITRIC ACID",
        "hazDescription": "CORROSIVE OXIDIZER",
        "hazNumType": "UN",
        "hazNum": "2031",
        "hazTcn": "M1358232245912XXX",
        "ashc": "RFL",
        "hazPieces": 29,
        "hazWeight": 22.1,
        "netExpWt": 12.1,
        "classDiv": "1.1",
        "cgc": "A",
        "lotNum": "1234A",
        "hazOnItin": 50,
        "hazOnICAO": "LIRQ",
        "hazOffItin": 300,
        "hazOffICAO": "MBPV",
        "hazmatRemarks": "Hazmat remarks"
      }
    ],
    "airLoadPlanPaxCargo": [
      {
        "groupType": "OFFTHIS",
        "requiredPax": 20,
        "availablePax": 20,
        "fnPax": 1,
        "dvPax": 2,
        "civPax": 3,
        "litPax": 4,
        "ambPax": 5,
        "attPax": 6,
        "numPallet": 20,
        "paxWeight": 8000.1,
        "bagWeight": 2000.1,
        "groupCargoWeight": 5000.1,
        "mailWeight": 200.1,
        "palletWeight": 400.1
      }
    ],
    "airLoadPlanPalletDetails": [
      {
        "pp": "2",
        "specialInterest": true,
        "category": "AMCMICAP",
        "ppDescription": "Ammunition",
        "ppTcn": "M1358232245912XXX",
        "ppPieces": 3,
        "ppWeight": 100.1,
        "ppOffICAO": "MBPV",
        "ppRemarks": "Pallet remarks"
      }
    ],
    "airLoadPlanHR": [
      {
        "name": "John Doe",
        "rank": "Captain",
        "service": "Air Force",
        "container": "Metal",
        "viewable": true,
        "escort": "Jane Doe",
        "recAgency": "Agency name",
        "hrOnItin": 100,
        "hrOnICAO": "KCOS",
        "hrOffItin": 200,
        "hrOffICAO": "KDEN",
        "hrEstArrTime": "2024-01-01T01:00:00.123Z",
        "hrRemarks": "HR remarks"
      }
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "sourceDL": "AXE",
    "source": "source",
    "origin": "THIRD_PARTY_DATASOURCE",
    "origNetwork": "OPS1",
    "dataMode": "TEST"
  }
]

Changes

May 29, 20254e1cbc17e814 Revision changes
- info
  added the new optional query request parameter firstResult
- info
  added the new optional query request parameter maxResults
Apr 16, 202575f764c843a9 Revision changes
- breaking
  the /// response property's maxLength was increased from 16 to 32 for the response status
- breaking
  the / response property's minLength was decreased from 1 to 0 for the response status
- info
  api operation id findAllTuples_2 removed and replaced with
- info
  the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.

Operation history