BLbluestaq
Mission Ops

GET /udl/personnelrecovery

Changed on

Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (/udl/<datatype>/queryhelp) for more details on valid/required query parameter information.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/personnelrecovery
  • Auth
    none declared

Query parameters

msgTimestring date-time required

Time stamp of the original personnel recovery message, in ISO 8601 UTC format. (YYYY-MM-DDTHH:MM:SS.sssZ)

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

classificationMarkingstring required

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

typestring 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.).

msgTimestring date-time required

Time stamp of the original personnel recovery message, in ISO 8601 UTC format.

recovIdstring

UUID identifying the Personnel Recovery mission, which should remain the same on subsequent posts related to the same recovery mission.

idWeatherReportstring

Unique identifier of a weather report associated with this recovery.

pickupLatnumber double required

WGS-84 latitude of the pickup location, in degrees. -90 to 90 degrees (negative values south of equator).

pickupLonnumber double required

WGS-84 longitude of the pickup location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).

pickupAltnumber 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.

termIndboolean

Flag indicating the cancellation of this recovery.

authStatusstring

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.

numPersonsinteger

The count of persons requiring recovery.

milClassstring

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).

natAllianceinteger

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).

natAlliance1integer

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.

identitystring

The survivor service identity (UNKNOWN MILITARY, UNKNOWN CIVILIAN, FRIEND MILITARY, FRIEND CIVIILIAN, NEUTRAL MILITARY, NEUTRAL CIVILIAN, HOSTILE MILITARY, HOSTILE CIVILIAN).

commEq1string

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).

commEq2string

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).

commEq3string

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).

txFreqnumber double

Transmit voice frequency in 5Hz increments.

rxFreqnumber double

Receive voice frequency in 5Hz increments. This field will auto populate with the txFreq value if the post element is null.

numNonAmbulatoryinteger

Number of littered personnel requiring recovery.

numAmbulatoryinteger

Number of ambulatory personnel requiring recovery.

numAmbulatoryInjuredinteger

Number of injured, but ambulatory, personnel requiring recovery.

survivorRadiostring

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).

survivorMessagesstring

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).

beaconIndboolean

Flag indicating whether a radio identifier is reported.

callSignstring

The call sign of the personnel to be recovered.

textMsgstring

Additional specific messages received from survivor.

authMethodstring

Mechanism used to verify the survivors identity.

origNetworkstring

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

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.

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.

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": "PERSONNEL_RECOVERY-ID",
    "classificationMarking": "U",
    "type": "MEDICAL",
    "msgTime": "2021-10-15T16:00:00.123Z",
    "recovId": "RECOV-ID",
    "idWeatherReport": "WEATHER_REPORT-ID",
    "pickupLat": 75.1234,
    "pickupLon": 175.1234,
    "pickupAlt": 30.1234,
    "termInd": true,
    "authStatus": "NO STATEMENT",
    "numPersons": 1,
    "milClass": "CIVILIAN",
    "natAlliance": 1,
    "identity": "NEUTRAL CIVILIAN",
    "commEq1": "LL PHONE",
    "commEq2": "LL PHONE",
    "commEq3": "LL PHONE",
    "txFreq": 5.5,
    "rxFreq": 5.5,
    "numAmbulatory": 1,
    "numAmbulatoryInjured": 2,
    "survivorRadio": "NO STATEMENT",
    "survivorMessages": "UNINJURED CANT MOVE HOSTILES NEARBY",
    "callSign": "BADGER",
    "textMsg": "Additional message from survivor.",
    "authMethod": "PASSPORT",
    "objectiveAreaInfo": {
      "pzLocation": [
        103.23,
        30.445
      ],
      "pzDesc": "Near the lake.",
      "oscCallSign": "STARFOX",
      "oscFreq": 12.55,
      "enemyData": [
        {
          "dirToEnemy": "NORTHWEST",
          "hostileFireType": "SMALL ARMS",
          "friendliesRemarks": "Comments from friendlies.",
          "hlzRemarks": "Hot Landing Zone remarks."
        }
      ]
    },
    "executionInfo": {
      "initialPoint": [
        103.23,
        30.445
      ],
      "ingress": 35.66,
      "objStrategy": "Description of strategy plan.",
      "egressPoint": [
        107.23,
        30.455
      ],
      "egress": 66.53,
      "recoveryVehicle": {
        "callSign": "FALCO",
        "type": "C17",
        "primaryFreq": 34.55,
        "strength": 5
      },
      "escortVehicle": {
        "callSign": "FALCO",
        "type": "C17",
        "primaryFreq": 34.55,
        "strength": 5
      }
    },
    "origNetwork": "OPS1",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST"
  }
]

Changes

  • 173e4aff893fRevision changes
    • breaking

      the // response property's minItems was decreased from 2 to 0 for the response status

    • breaking

      the // response property's minItems was decreased from 2 to 0 for the response status

    • breaking

      the // response property's minItems was decreased from 2 to 0 for the response status

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.