--- title: "GET /udl/personnelrecovery" method: GET path: "/udl/personnelrecovery" tags: ["Mission Ops"] --- # GET /udl/personnelrecovery `GET /udl/personnelrecovery` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/personnelrecovery` - 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 - `msgTime` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - PersonnelRecoveryAbridged[] - `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. - `type` string, required: Specifies the type of incident resulting in a recovery or evacuation mission. Intended as, but not constrained to, MIL-STD-6016 J6.1 Emergency Type (e.g. NO STATEMENT, DOWN AIRCRAFT, MAN IN WATER, DITCHING, BAILOUT, DISTRESSED VEHICLE, GROUND INCIDENT, MEDICAL, ISOLATED PERSONS, etc.). - `msgTime` string, date-time, required: Time stamp of the original personnel recovery message, in ISO 8601 UTC format. - `recovId` string: UUID identifying the Personnel Recovery mission, which should remain the same on subsequent posts related to the same recovery mission. - `idWeatherReport` string: Unique identifier of a weather report associated with this recovery. - `pickupLat` number, double, required: WGS-84 latitude of the pickup location, in degrees. -90 to 90 degrees (negative values south of equator). - `pickupLon` number, double, required: WGS-84 longitude of the pickup location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `pickupAlt` number, double: Altitude relative to WGS-84 ellipsoid, in meters. Positive values indicate a point height above ellipsoid, and negative values indicate a point eight below ellipsoid. - `termInd` boolean: Flag indicating the cancellation of this recovery. - `authStatus` string: The confirmation status of the isolated personnel identity. Intended as, but not constrained to, MIL-STD-6016 J6.1 Authentication Status, Isolated Personnel (NO STATEMENT, AUTHENTICATED, NOT AUTHENTICATED, AUTHENTICATED UNDER DURESS, NOT APPLICABLE): AUTHENTICATED: Confirmed Friend NOT AUTHENTICATED: Unconfirmed status AUTHENTICATED UNDER DURESS: Authentication comprised by hostiles. NOT APPLICABLE: Authentication not required. - `numPersons` integer: The count of persons requiring recovery. - `milClass` string: The military classification of the personnel to be recovered. Intended as, but not constrained to, MIL-STD-6016 J6.1 Isolated Personnel Classification (NO STATEMENT, MILITARY, GOVERNMENT CIVILIAN, GOVERNMENT CONTRACTOR, CIVILIAN, MULTIPLE CLASSIFICATIONS). - `natAlliance` integer: The country of origin or political entity of an isolated person subject to rescue or evacuation. If natAlliance is set to 126, then natAlliance1 must be non 0. If natAlliance is any number other than 126, then natAlliance1 will be set to 0 regardless. Defined in MIL-STD-6016 J6.1 Nationality/Alliance isolated person(s). - `natAlliance1` integer: Extended country of origin or political entity of an isolated person subject to rescue or evacuation. Specify an entry here only if natAlliance is 126. Defined in MIL-STD-6016 J6.1 Nationality/Alliance isolated person(s), 1. - `identity` string: The survivor service identity (UNKNOWN MILITARY, UNKNOWN CIVILIAN, FRIEND MILITARY, FRIEND CIVIILIAN, NEUTRAL MILITARY, NEUTRAL CIVILIAN, HOSTILE MILITARY, HOSTILE CIVILIAN). - `commEq1` string: Survivor communications equipment. Intended as, but not constrained to, MIL-STD-6016 J6.1 Communications Equipment, Isolated Personnel (NO STATEMENT, SURVIVAL RADIO, RADIO BEACON, EPLRS, SIGNAL MIRROR, SMOKE FLARE, IR SIGNALLING DEVICE, SIGNALLING PANEL, FRIENDLY FORCE TRACKER, GPS BEACON, LL PHONE, TACTICAL RADIO LOS, TACTICAL RADIO BLOS). - `commEq2` string: Survivor communications equipment. Intended as, but not constrained to, MIL-STD-6016 J6.1 Communications Equipment, Isolated Personnel (NO STATEMENT, SURVIVAL RADIO, RADIO BEACON, EPLRS, SIGNAL MIRROR, SMOKE FLARE, IR SIGNALLING DEVICE, SIGNALLING PANEL, FRIENDLY FORCE TRACKER, GPS BEACON, LL PHONE, TACTICAL RADIO LOS, TACTICAL RADIO BLOS). - `commEq3` string: Survivor communications equipment. Intended as, but not constrained to, MIL-STD-6016 J6.1 Communications Equipment, Isolated Personnel (NO STATEMENT, SURVIVAL RADIO, RADIO BEACON, EPLRS, SIGNAL MIRROR, SMOKE FLARE, IR SIGNALLING DEVICE, SIGNALLING PANEL, FRIENDLY FORCE TRACKER, GPS BEACON, LL PHONE, TACTICAL RADIO LOS, TACTICAL RADIO BLOS). - `txFreq` number, double: Transmit voice frequency in 5Hz increments. - `rxFreq` number, double: Receive voice frequency in 5Hz increments. This field will auto populate with the txFreq value if the post element is null. - `numNonAmbulatory` integer: Number of littered personnel requiring recovery. - `numAmbulatory` integer: Number of ambulatory personnel requiring recovery. - `numAmbulatoryInjured` integer: Number of injured, but ambulatory, personnel requiring recovery. - `survivorRadio` string: Survivor radio equipment. Intended as, but not constrained to, MIL-STD-6016 J6.1 Survivor Radio Type (NO STATEMENT, PRQ7SEL, PRC90, PRC112, PRC112B B1, PRC112C, PRC112D, PRC148 MBITR, PRC148 JEM, PRC149, PRC152, ACRPLB, OTHER). - `survivorMessages` string: Preloaded message conveying the situation confronting the isolated person(s). Intended as, but not constrained to, MIL-STD-6016 J6.1 Survivor Radio Messages (e.g. INJURED CANT MOVE NO KNOWN HOSTILES, INJURED CANT MOVE HOSTILES NEARBY, UNINJURED CANT MOVE HOSTILES NEARBY, UNINJURED NO KNOWN HOSTILES, INJURED LIMITED MOBILITY). - `beaconInd` boolean: Flag indicating whether a radio identifier is reported. - `callSign` string: The call sign of the personnel to be recovered. - `textMsg` string: Additional specific messages received from survivor. - `authMethod` string: Mechanism used to verify the survivors identity. - `objectiveAreaInfo` PersonnelRecoveryObjectiveAreaInfoAbridged - `pzLocation` number[]: Array of the WGS-84 latitude (-90 to 90, negative values south of the equator) in degrees, longitude (-180 to 180, negative values west of Prime Meridian) in degrees, and altitude, in meters, of the pz location. This array must contain a minimum of 2 elements (latitude and longitude), and may contain an optional 3rd element (altitude). - `pzDesc` string: Description of the pickup zone location. - `oscCallSign` string: The call sign of the on-scene commander. - `oscFreq` number, double: The radio frequency of the on-scene commander. - `enemyData` PersonnelRecoveryEnemyDataAbridged[]: Information detailing knowledge of enemies in the area. - `dirToEnemy` string: Directions to known enemies in the operation area (NORTH, NORTHEAST, EAST, SOUTHEAST, SOUTH, SOUTHWEST, WEST, NORTHWEST, SURROUNDED). - `hostileFireType` string: The type of hostile fire received (SMALL ARMS, MORTAR, ARTILLERY, ROCKETS). - `friendliesRemarks` string: Comments provided by friendlies about the evac zone. - `hlzRemarks` string: Hot Landing Zone remarks. - `executionInfo` PersonnelRecoveryExecutionInfoAbridged - `initialPoint` number[]: Array of the WGS-84 latitude (-90 to 90, negative values south of the equator) in degrees, longitude (-180 to 180, negative values west of Prime Meridian) in degrees, and altitude, in meters, of the initial location. This array must contain a minimum of 2 elements (latitude and longitude), and may contain an optional 3rd element (altitude). - `ingress` number, double: The heading, in degrees clockwise from North, of entering the recovery zone. - `objStrategy` string: Description of the objective strategy plan. - `egressPoint` number[]: Array of the WGS-84 latitude (-90 to 90, negative values south of the equator) in degrees, longitude (-180 to 180, negative values west of Prime Meridian) in degrees, and altitude, in meters, of the egress location. This array must contain a minimum of 2 elements (latitude and longitude), and may contain an optional 3rd element (altitude). - `egress` number, double: The heading, in degrees, of leaving the recovery zone. - `recoveryVehicle` PersonnelRecoveryVehicleAbridged - `callSign` string: The call sign of the recovery vehicle. - `type` string: The particular type of recovery vehicle to be used. - `primaryFreq` number, double: Primary contact frequency of the recovery vehicle. - `strength` integer: The number of objects or units moving as a group and represented as a single entity in this recovery vehicle message. If null, the strength is assumed to represent a single object. Note that if this recovery derives from a J-series message then special definitions apply for the following values: 13 indicates an estimated 2-7 units, 14 indicates an estimated more than 7 units, and 15 indicates an estimated more than 12 units. - `escortVehicle` PersonnelRecoveryVehicleAbridged - `callSign` string: The call sign of the recovery vehicle. - `type` string: The particular type of recovery vehicle to be used. - `primaryFreq` number, double: Primary contact frequency of the recovery vehicle. - `strength` integer: The number of objects or units moving as a group and represented as a single entity in this recovery vehicle message. If null, the strength is assumed to represent a single object. Note that if this recovery derives from a J-series message then special definitions apply for the following values: 13 indicates an estimated 2-7 units, 14 indicates an estimated more than 7 units, and 15 indicates an estimated more than 12 units. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `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. - `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. ## 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. - **2026-03-25** `173e4aff893f`: 3 breaking - the `items/executionInfo/egressPoint` response property's minItems was decreased from `2` to `0` for the response status `200` - the `items/executionInfo/initialPoint` response property's minItems was decreased from `2` to `0` for the response status `200` - the `items/objectiveAreaInfo/pzLocation` response property's minItems was decreased from `2` to `0` for the response status `200` - **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 info - api operation id `findAll_89` 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/personnelrecovery/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)