--- title: "GET /udl/airloadplan/{id}" method: GET path: "/udl/airloadplan/{id}" tags: ["AirOperations"] --- # GET /udl/airloadplan/{id} `GET /udl/airloadplan/{id}` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/airloadplan/{id}` - Auth: none declared Service operation to get a single airloadplan record by its unique ID passed as a path parameter. ## Path parameters - `id` string, required ## Query parameters - `firstResult` integer - `maxResults` integer ## Response `200` OK - AirLoadPlanFull: Information related to how an aircraft is loaded with cargo, equipment, and passengers. - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `externalId` string: 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. - `idMission` string: The UDL ID of the mission this record is associated with. - `missionNumber` string: The mission number of the mission supporting this load plan. - `idSortie` string: The UDL ID of the aircraft sortie this record is associated with. - `legNum` integer: The leg number of the mission supporting this load plan. - `callSign` string: The call sign of the mission supporting this load plan. - `tailNumber` string: The tail number of the aircraft supporting this load plan. - `aircraftMDS` string: The Model Design Series designation of the aircraft supporting this load plan. - `depICAO` string: The departure International Civil Organization (ICAO) code of the departure airfield. - `depAirfield` string: Optional identifier of departure airfield with no International Civil Organization (ICAO) code. - `estDepTime` string, date-time, required: The current estimated time that the aircraft is planned to depart, in ISO 8601 UTC format with millisecond precision. - `arrICAO` string: The arrival International Civil Organization (ICAO) code of the landing airfield. - `arrAirfield` string: Optional identifier of arrival airfield with no International Civil Organization (ICAO) code. - `estArrTime` string, date-time: The current estimated time that the aircraft is planned to arrive, in ISO 8601 UTC format with millisecond precision. - `crewSize` integer: The number of crew members on the aircraft. - `cargoConfig` string: 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. - `equipConfig` string: Description of the equipment configuration (e.g. Standard, Ferry, JBLM, CHS, Combat, etc.). Configuration meanings are determined by the data source. - `tankConfig` string: Description of the fuel tank(s) configuration (e.g. ER, NON-ER, etc.). Configuration meanings are determined by the data source. - `basicWeight` number, double: The weight of the aircraft without passengers, cargo, equipment, or usable fuel, in kilograms. - `basicMoment` number, 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. - `fuelWeight` number, double: The weight of usable fuel on board the aircraft, in kilograms. - `fuelMoment` number, 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. - `estLandingFuelWeight` number, double: The estimated weight of usable fuel upon landing, in kilograms. - `estLandingFuelMoment` number, 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. - `operatingWeight` number, double: The basic weight of the aircraft including passengers and equipment, in kilograms. - `operatingMoment` number, 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. - `cargoWeight` number, double: The weight of the cargo on board the aircraft, in kilograms. - `cargoMoment` number, 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. - `zeroFuelWeight` number, double: The operating weight of the aircraft including cargo, mail, baggage, and passengers, but without usable fuel, in kilograms. - `zeroFuelMoment` number, 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. - `zeroFuelCG` number, 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). - `grossWeight` number, double: The total weight of the aircraft at takeoff including passengers, cargo, equipment, and usable fuel, in kilograms. - `grossMoment` number, double: The sum of moments of all items making up the gross weight of the aircraft, in Newton-meters. - `grossCG` number, double: The center of gravity of the aircraft using the gross weight and gross moment, as a percentage of the mean aerodynamic chord (%MAC). - `landingWeight` number, double: The gross weight of the aircraft upon landing, in kilograms. - `landingMoment` number, double: The sum of moments of all items making up the gross weight of the aircraft upon landing, in Newton-meters. - `landingCG` number, double: The center of gravity of the aircraft using the landing weight and landing moment, as a percentage of the mean aerodynamic chord (%MAC). - `seatsOnboard` integer: Number of passenger seats on the aircraft. - `seatsReleased` integer: Number of passenger seats released this leg. - `ppOnboard` integer: Number of pallet positions on the aircraft. - `ppReleased` integer: Number of pallet positions released this leg. - `aclOnboard` number, 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. - `aclReleased` number, double: Allowable Cabin Load (ACL) released this leg. The weight of passengers, baggage, and cargo released from the aircraft cabin, in kilograms. - `cargoBayFSMin` number, double: Minimum fuselage station (FS) where cargo can be stored. FS is the distance from the reference datum, in meters. - `cargoBayFSMax` number, double: Maximum fuselage station (FS) where cargo can be stored. FS is the distance from the reference datum, in meters. - `cargoBayWidth` number, double: Width of the cargo bay, in meters. - `cargoVolume` number, double: Volume of cargo space in the aircraft, in cubic meters. - `loadmasterName` string: Name of the loadmaster or boom operator who received the cargo briefing. - `loadmasterRank` string: Rank of the loadmaster or boom operator overseeing cargo loading/unloading. - `availableTime` string, date-time: Time the loadmaster or boom operator is available for cargo loading/unloading, in ISO 8601 UTC format with millisecond precision. - `schedTime` string, date-time: Time the loadmaster or boom operator is scheduled to begin overseeing cargo loading/unloading, in ISO 8601 UTC format with millisecond precision. - `briefTime` string, date-time: Time the cargo briefing was given to the loadmaster or boom operator, in ISO 8601 UTC format with millisecond precision. - `utilCode` string: Alphanumeric code that describes general cargo-related utilization and characteristics for an itinerary point. - `loadRemarks` string: Remarks concerning this load plan. - `airLoadPlanULNActuals` AirLoadPlanULNActualsFull[]: Collection of unit line number actuals associated with this load plan. - `onloadId` integer: Identifier of the onload itinerary location. - `onloadLOCode` string: Onload location code. - `offloadId` integer: Identifier of the offload itinerary location. - `offloadLOCode` string: Offload location code. - `uln` string: Unit line number. - `projName` string: Project name. - `oplan` string: Identification number of the Operation Plan (OPLAN) associated with this load plan. - `numPax` integer: Number of passengers associated with this load plan. - `numLitter` integer: Number of litter patients associated with this load plan. - `numAmbulatory` integer: Number of ambulatory patients associated with this load plan. - `numAttendant` integer: Number of attendants associated with this load plan. - `ulnCargoWeight` number, double: Total weight of all cargo items for this unit line number in kilograms. - `ulnRemarks` string: Remarks concerning these unit line number actuals. - `airLoadPlanHazmatActuals` AirLoadPlanHazmatActualsFull[]: Collection of hazmat actuals associated with this load plan. - `itemName` string: United Nations proper shipping name of the hazardous material according to the Hazardous Materials Regulations issued by the U.S. Department of Transportation. - `hazDescription` string: Description of the hazardous item. - `hazNumType` string: Designates the type of hazmat number for the item (UN for United Nations or NA for North American). - `hazNum` string: United Nations number or North American number that identifies hazardous materials according to the Hazardous Materials Regulations issued by the U.S. Department of Transportation. - `hazTcn` string: Transportation Control Number (TCN) of the hazardous item. - `ashc` string: The Air Special Handling Code (ASHC) indicates the type of special handling required for hazardous cargo. - `hazPieces` integer: Number of pieces of hazardous cargo. - `hazWeight` number, double: Total weight of hazardous cargo, including non-explosive parts, in kilograms. - `netExpWt` number, double: Net explosive weight of the hazardous material, in kilograms. - `classDiv` string: Class and division of the hazardous material according to the Hazardous Materials Regulations issued by the U.S. Department of Transportation. - `cgc` string: Compatibility group code used to specify the controls for the transportation and storage of hazardous materials according to the Hazardous Materials Regulations issued by the U.S. Department of Transportation. - `lotNum` string: Manufacturer's lot number for identification of the hazardous material. - `hazOnItin` integer: Itinerary number that identifies where the hazardous material is loaded. - `hazOnICAO` string: The International Civil Aviation Organization (ICAO) code of the site where the hazardous material is loaded. - `hazOffItin` integer: Itinerary number that identifies where the hazardous material is unloaded. - `hazOffICAO` string: The International Civil Aviation Organization (ICAO) code of the site where the hazardous material is unloaded. - `hazmatRemarks` string: Remarks concerning this hazardous material. - `airLoadPlanPaxCargo` AirLoadPlanPaxCargoFull[]: Collection of passenger and cargo details associated with this load plan for this leg of the mission. - `groupType` string: Describes the status or action needed for this group of passenger and cargo data (e.g. ARRONBD, OFFTHIS, THROUGH, ONTHIS, DEPONBD, OFFNEXT). - `requiredPax` integer: Number of space required passengers in this group. - `availablePax` integer: Number of space available passengers in this group. - `fnPax` integer: Number of foreign national passengers in this group. - `dvPax` integer: Number of distinguished visitor passengers in this group. - `civPax` integer: Number of civilian passengers in this group. - `litPax` integer: Number of litter-bound passengers in this group. - `ambPax` integer: Number of ambulatory medical passengers in this group. - `attPax` integer: Number of patient attendant passengers in this group. - `numPallet` integer: Number of cargo pallets in this group. - `paxWeight` number, double: Weight of passengers in this group in kilograms. - `bagWeight` number, double: Weight of baggage in this group in kilograms. - `groupCargoWeight` number, double: Weight of cargo in this group in kilograms. - `mailWeight` number, double: Weight of mail in this group in kilograms. - `palletWeight` number, double: Weight of pallets, chains, and devices in this group in kilograms. - `airLoadPlanPalletDetails` AirLoadPlanPalletDetailsFull[]: Collection of cargo information located at the pallet positions associated with this load plan. - `pp` string: Pallet position of the cargo. - `specialInterest` boolean: Flag indicating if this cargo is considered special interest. - `category` string: Category of special interest cargo. - `ppDescription` string: Description of the cargo. - `ppTcn` string: Transportation Control Number (TCN) of the cargo. - `ppPieces` integer: Number of pieces included in the Transportation Control Number (TCN). - `ppWeight` number, double: Total weight of the cargo at this pallet position in kilograms. - `ppOffICAO` string: The International Civil Aviation Organization (ICAO) code of the site where the cargo is unloaded. - `ppRemarks` string: Remarks concerning the cargo at this pallet position. - `airLoadPlanHR` AirLoadPlanHRFull[]: Collection of human remains transport information associated with this load plan. - `name` string: Name of the deceased. - `rank` string: Rank of the deceased. - `service` string: Branch of service of the deceased. - `container` string: Type of transfer case used. - `viewable` boolean: Flag indicating if the remains are viewable. - `escort` string: Name of the escort for the remains. - `recAgency` string: Name of the receiving agency or funeral home to which the remains are being delivered. - `hrOnItin` integer: Itinerary number that identifies where the remains are loaded. - `hrOnICAO` string: The International Civil Aviation Organization (ICAO) code of the site where the remains are loaded. - `hrOffItin` integer: Itinerary number that identifies where the remains are unloaded. - `hrOffICAO` string: The International Civil Aviation Organization (ICAO) code of the site where the remains are unloaded. - `hrEstArrTime` string, date-time: The current estimated time of arrival for the remains in ISO 8601 UTC format with millisecond precision. - `hrRemarks` string: Remarks concerning the remains. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `updatedAt` string, date-time: Time the row was updated in the database, auto-populated by the system. - `updatedBy` string: Application user who updated the row in the database, auto-populated by the system. - `sourceDL` string: 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. - `source` string, required: Source of the data. - `origin` string: 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. - `origNetwork` string: 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. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `404`: Item Not Found - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 2 breaking, 2 info - the `airLoadPlanPalletDetails/items/ppTcn` response property's maxLength was increased from `16` to `32` for the response status `200` - the `externalId` response property's minLength was decreased from `1` to `0` for the response status `200` - api operation id `find_1` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/airloadplan/:id/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)