BLbluestaq
AirOperations

GET /udl/diplomaticclearance/{id}

Changed on

Service operation to get a single diplomatic clearance record by its unique ID passed as a path parameter.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/diplomaticclearance/{id}
  • Auth
    none declared

Path parameters

idstring required

The ID of the diplomatic clearance record to retrieve.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

Unique identifier of the record, auto-generated by the system if not provided on create operations.

classificationMarkingstring required

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

idMissionstring required

Unique identifier of the Mission associated with this diplomatic clearance record.

externalWorksheetIdstring

Optional diplomatic clearance worksheet 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.

dipWorksheetNamestring

Identifier of the Diplomatic Clearance Worksheet used to coordinate aircraft clearance requests.

firstDepDatestring date-time required

The First Departure Date (FDD) the mission is scheduled for departure, in ISO 8601 UTC format with millisecond precision.

docDeadlinestring date-time

Suspense date for the diplomatic clearance worksheet to be worked, in ISO 8601 UTC format with millisecond precision.

apacsIdstring

The Aircraft and Personnel Automated Clearance System (APACS) system identifier used to process and approve this clearance request.

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": "25059135-4afc-45c2-b78b-d6e843dbd96d",
  "classificationMarking": "U",
  "idMission": "0dba1363-2d09-49fa-a784-4bb4cbb1674a",
  "externalWorksheetId": "990ae849089e3d6cad69655324176bb6",
  "dipWorksheetName": "G2-939911-AC",
  "firstDepDate": "2024-01-01T01:01:01.123Z",
  "docDeadline": "2024-01-01T01:01:01.123Z",
  "apacsId": "1083034",
  "diplomaticClearanceDetails": [
    {
      "idSortie": "207010e0-f97d-431c-8c00-7e46acfef0f5",
      "legNum": 825,
      "routeString": "DCT DOH P430 BAYAN/M062F150 P430 RAMKI",
      "validStartTime": "2024-01-01T01:01:01.123Z",
      "validEndTime": "2024-01-01T01:01:01.123Z",
      "clearanceId": "MFMW225662GHQ",
      "externalClearanceId": "aa714f4d52a37ab1a00b21af9566e379",
      "clearedCallSign": "FALCN09",
      "sequenceNum": 3,
      "countryCode": "NL",
      "altCountryCode": "IZ",
      "countryName": "NETHERLANDS",
      "validDesc": "CY2023",
      "windowRemark": "Period remarks",
      "entryPoint": "LOMOS",
      "entryNET": "2024-01-01T01:01:01.123Z",
      "exitPoint": "BUDOP",
      "exitNLT": "2024-01-01T01:01:01.123Z",
      "reqICAO": true,
      "action": "O",
      "status": "IN WORK",
      "profile": "T LAND/OFLY IATA COMPLIANT CARGO 23",
      "reqPoint": true,
      "clearanceRemark": "Clearance remarks"
    }
  ],
  "diplomaticClearanceRemarks": [
    {
      "gdssRemarkId": "GDSSREMARK-ID",
      "text": "Example mission remarks.",
      "date": "2024-01-01T01:01:01.123Z",
      "user": "John Doe"
    }
  ],
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "updatedAt": "2018-01-01T16:00:00.123Z",
  "updatedBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id find_32 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.