BLbluestaq
Report and Activity

GET /udl/routestats

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/routestats
  • Auth
    none declared

Query parameters

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.

idSiteStartstring

Unique identifier of the Site at the route's starting location. This ID can be used to obtain additional information on a Site using the 'get by ID' operation (e.g. /udl/site/{id}). For example, the Site object with idSite = abc would be queried as /udl/site/abc.

idSiteEndstring

Unique identifier of the Site at the route's end location. This ID can be used to obtain additional information on a Site using the 'get by ID' operation (e.g. /udl/site/{id}). For example, the Site object with idSite = abc would be queried as /udl/site/abc.

locationStartstring required

Starting location of the vehicle.

locationEndstring required

End location of the vehicle.

locationTypestring

Type of location used for route start and end points (e.g., ICAO, PORT, etc.).

distancenumber double

Distance between the departure and arrival locations in the indicated unit of measurement, distUnit.

distUnitstring

The unit of measurement used for distance in this calculation.

vehicleCategorystring

The vehicle category that is the subject of this calculation (e.g., AIRCRAFT, CAR, BOAT, etc.).

vehicleTypestring

The vehicle type that is the subject of this calculation (e.g., C-17, F-15, etc.).

idealDurationnumber double

Estimated ideal travel duration in hours for the full distance using the indicated vehicle type. The field "idealDesc" should be used to describe the ideal travel route.

idealDescstring

Description of the portion of travel used to estimate the value of the idealDuration field.

partialDurationnumber double

Estimated ideal travel duration in hours for a partial distance using the indicated vehicle type. The field "partialDesc" should be used to specify the intended portion of travel.

partialDescstring

Description of the portion of travel used to estimate the value of the partialDuration field.

avgDurationnumber double

Average travel duration for the indicated distance and type of vehicle in hours.

minDurationnumber double

Minimum travel duration for the indicated distance and type of vehicle in hours.

maxDurationnumber double

Maximum travel duration for the indicated distance and type of vehicle in hours.

avgSpeednumber double

Average speed during travel in the indicated unit of measurement, speedUnit.

minSpeednumber double

Minimum speed during travel in the indicated unit of measurement, speedUnit.

maxSpeednumber double

Maximum speed during travel in the indicated unit of measurement, speedUnit.

speedUnitstring

The unit of measurement used for speed in this calculation.

timePeriodstring

The time period this data was collected.

firstPtstring date-time

Date of the first data point used in this calculation, in ISO8601 UTC format with millisecond precision.

lastPtstring date-time

Date of the last data point used in this calculation, in ISO8601 UTC format with millisecond precision.

dataPtsUsedinteger

The number of data points used in this travel duration calculation.

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.

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.

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.

origNetworkstring

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

Example response

[
  {
    "id": "0167f577-e06c-358e-85aa-0a07a730bdd0",
    "classificationMarking": "U",
    "idSiteStart": "23370387-5e8e-4a74-89db-ad81145aa4df",
    "idSiteEnd": "77b5550c-c0f4-47bd-94ce-d71cdaa52f62",
    "locationStart": "KDEN",
    "locationEnd": "KCOS",
    "locationType": "ICAO",
    "distance": 63.1,
    "distUnit": "Nautical miles",
    "vehicleCategory": "AIRCRAFT",
    "vehicleType": "C-17",
    "idealDuration": 45.1,
    "idealDesc": "Block speed using great circle path",
    "partialDuration": 38.1,
    "partialDesc": "Performance speed using great circle path",
    "avgDuration": 47.1,
    "minDuration": 42.1,
    "maxDuration": 52.1,
    "avgSpeed": 450.1,
    "minSpeed": 420.1,
    "maxSpeed": 470.1,
    "speedUnit": "knots",
    "timePeriod": "Q1",
    "firstPt": "2024-01-01T16:00:00.123Z",
    "lastPt": "2024-03-31T16:00:00.123Z",
    "dataPtsUsed": 6,
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "sourceDL": "AXE",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

Changes

Some revisions have not been checked yet.