--- title: "GET /udl/aircraftstatus" method: GET path: "/udl/aircraftstatus" tags: ["Aircraft"] --- # GET /udl/aircraftstatus `GET /udl/aircraftstatus` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/aircraftstatus` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `firstResult` integer - `maxResults` integer ## Response `200` OK - AircraftStatusAbridged[] - `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. - `idAircraft` string, required: Unique identifier of the aircraft. - `altAircraftId` string: Alternate Aircraft Identifier provided by source. - `currentState` string: The current readiness state of the aircraft (e.g. AIRBORNE, ALERTCOCKED, AVAILABLE, BATTLESTATION, RUNWAY ALERT, SUITUP). - `idAirfield` string: If not airborne, the unique identifier of the installation currently hosting the aircraft. - `geoLoc` string: US Air Force geographic location code of the airfield where the aircraft is located. - `previousICAO` string: The International Civil Aviation Organization (ICAO) code at which this aircraft was previously located. - `currentICAO` string: The International Civil Aviation Organization (ICAO) code at which this aircraft is currently located or has most recently departed, if airborne. - `nextICAO` string: The International Civil Aviation Organization (ICAO) code of the next destination of this aircraft. - `flightPhase` string: Current flight phase (e.g. AIR REFUELING, GROUND, LANDING, etc.) of the aircraft. - `taStartTime` string, date-time: The turnaround start time, in ISO 8601 UTC format with millisecond precision. - `earliestTAEndTime` string, date-time: The earliest time that turnaround of the aircraft may complete, in ISO 8601 UTC format with millisecond precision. - `missionReadiness` string: The Operational Capability of the reported aircraft (ABLE, LOFUEL, UNABLE). - `fuel` integer: The mass of fuel remaining on the aircraft, in kilograms. - `fuelFunction` string: Used in conjunction with the fuel field to indicate either burnable or offload fuel. - `gunCapable` boolean: Flag indicating that the aircraft is capable of making at least one gun pass. - `gunRdsType` string: The type of gun rounds available (e.g. 7.62 MM, 20 MM, 25 MM, etc.). - `gunRdsMin` integer: The lower bound of the estimated number of gun rounds available. - `gunRdsMax` integer: The upper bound of the estimated number of gun rounds available. - `airToAirStatus` 'OPERATIONAL' | 'NON-OPERATIONAL' | 'OFF': The status of the air-to-air weapon release system (OPERATIONAL, NON-OPERATIONAL, OFF). - `airToGroundStatus` 'OPERATIONAL' | 'NON-OPERATIONAL' | 'OFF': The status of the air-to-ground weapon release system (OPERATIONAL, NON-OPERATIONAL, OFF). - `inventory` string[]: Array of inventory item(s) for which estimate(s) are available (e.g. AIM-9 SIDEWINDER, AIM-120 AMRAAM, AIM-92 STINGER, CHAFF DECOY, FLARE TP 400, etc.). Intended as, but not constrained to, MIL-STD-6016 environment dependent specific/store type designations. This array must be the same length as inventoryMin and inventoryMax. - `inventoryMin` integer[]: Array of the lower bound quantity for each of the inventory items. The values in this array must correspond to position index in the inventory array. This array must be the same length as inventory and inventoryMax. - `inventoryMax` integer[]: Array of the upper bound quantity for each of the inventory items. The values in this array must correspond to position index in the inventory array. This array must be the same length as inventory and inventoryMin. - `unavailableSys` string[]: List of unavailable systems that would normally be on this aircraft. - `additionalSys` string[]: List of additional operational systems on this aircraft beyond what is normally available. - `notes` string: Optional notes/comments concerning this aircraft status. - `mxRemark` string: Maintenance pacing remarks assocociated with this aircraft. - `maintStatus` string: The maintenance status of the aircraft. - `maintStatusDriver` string: Indicates the maintenance discrepancy that drives the current maintenance status. - `maintPriority` string: Indicates the priority of the maintenance effort. - `alphaStatusCode` string: Aircraft alpha status code that indicates the aircraft maintenance status estimated by the pilot. - `maintStatusUpdate` string, date-time: The time of the last maintenance status update, in ISO 8601 UTC format with millisecond precision. - `lastInspectionDate` string, date-time: Date when the military aircraft inspection was last performed, in ISO 8601 UTC format with millisecond precision. - `maintPoc` string: Military aircraft maintenance point of contact for this aircraft. - `groundStatus` string: The ground status of the aircraft (e.g. ALERT, CREW READY, ENGINE START, HANGAR, etc.). - `contaminationStatus` string: The contamination status of the aircraft (e.g. CLEAR, CONTAMINATED, DECONTAMINATED, UNKNOWN, etc.). - `fuelStatus` string: The state of the aircraft fuel status (e.g. DELIVERED, DUMPED, EMPTY, FULL, OTHER, REQUESTED, etc.). - `lastUpdatedBy` string: The name or ID of the external user that updated this status. - `troubleshootEtic` string, date-time: Estimated Time for Completion (ETIC) of an aircraft issue, in ISO 8601 UTC format with millisecond precision. This is the estimated time when the course of action to resolve the issue will be determined. - `etic` string, date-time: The Expected Time in Commission (ETIC) for this aircraft, in ISO 8601 UTC format with millisecond precision. This is the estimated time when the issue will be resolved. - `parkLocation` string: The parking location of this aircraft. - `parkLocationSystem` string: The system that designated the parking location (e.g. EMOC, GDSS, PEX, etc.). - `idPOI` string: Unique identifier of the Point of Interest (POI) record related to this aircraft status. This will generally represent the location of an aircraft on the ground. - `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. - `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. - `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. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `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`: 1 breaking, 2 info - the `items/maintPoc` response property's maxLength was increased from `32` to `128` for the response status `200` - api operation id `findAll_6` 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/aircraftstatus/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)