BLbluestaq
AirOperations

GET /udl/itemtracking

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

Query parameters

tsstring date-time required

The timestamp of the scan, in ISO 8601 UTC format with millisecond precision. (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.

scanCodestring required

The tracking identifier of an item or person. May be similar in representation of a barcode or UPC.

scGenToolstring

The algorithm name or standard that generated the scanCode (e.g. UPC-A, EAN-13, GTIN, SSCC, bID, JAN, etc.).

scannerIdstring required

The ID of the scanner or input device.

tsstring date-time required

The timestamp of the scan, in ISO 8601 UTC format with millisecond precision.

idItemstring

The UDL ID of the item this record is associated with.

typestring

The type of item that is being scanned (e.g. CARGO, PERSON, MAIL, MICAP, OTHER).

latnumber double

WGS84 latitude where the item was scanned, in degrees.

lonnumber double

WGS84 longitude where the item was scanned, in degrees.

scanTypestring

The type of scan for tracking the item within it's journey (e.g. IN, OUT, RECEIVED, DELIVERED, TRANSIT, ABANDONDED, REFUSED, UNABLE, RETURNED, HELD, OTHER). For example, received and delivered are for when an item is received from or delivered to the end customer. In and out are for stops in between such as being loaded on an airplane or received at a warehouse.

dvCodestring

The United States distinguished visitor code of the person scanned, only applicable to people.

notesstring

Optional notes or comments about the tracking data.

keysstring[]

Array of keys that may be associated with this tracked item.

valuesstring[]

Array of values for the keys that may be associated to this tracked item. The entries in this array must correspond to the position index in the keys array. This array must be the same length as keys.

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.

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": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "scanCode": "ABC1234",
    "scGenTool": "bID",
    "scannerId": "2051M",
    "ts": "2023-03-21T14:22:00.123Z",
    "idItem": "36054487-bcba-6e2d-4f3b-9f25738b2639",
    "type": "CARGO",
    "lat": 45.23,
    "lon": 179.1,
    "scanType": "TRANSIT",
    "dvCode": "DV-4",
    "notes": "Example notes",
    "keys": [
      "tapeColor",
      "hazmat"
    ],
    "values": [
      "yellow",
      "false"
    ],
    "createdAt": "2023-03-21T16:00:00.123Z",
    "createdBy": "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 findAll_52 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.