BLbluestaq
Site

GET /udl/port

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

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.

idSitestring

Unique identifier of the Site Entity associated with the Port record.

externalIdstring

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

locodestring

The five-character United Nations Code for Trade and Transport Locations (UN/LOCODE) of this port. The first two letters of the code contains the ISO 3166-1 alpha-2 country designation of the port country. The three remaining characters identify a location within that country. Letters are preferred, but if necessary digits 2 through 9 may be used, excluding "0" and "1" to avoid confusion with the letters "O" and "I" respectively.

portNamestring

The name of this port.

harborTypestring

The type of harbor for this port. The harbor type refers to how a port is physically positioned.

COASTAL BREAKWATER (CB)

COASTAL NATURAL (CN)

COASTAL TIDE GATE (CT)

LAKE OR CANAL (LC)

OPEN ROADSTEAD (OR)

RIVER BASIN (RB)

RIVER NATURAL (RN)

RIVER TIDE GATE (RT)

TYPHOON HARBOR (TH).

harborSizenumber double

The size of the harbor for this port measured in square kilometers.

maxDraughtnumber double

Maximum allowed vessel draught. Draught is the principal dimensions of any waterborne vessel defined as the distance between the ship’s keel and the waterline of the vessel measured in meters.

avgDurationnumber double

Average time for a vessel at this port in hours.

tideRangenumber double

The tide range of this port in meters.

shelterstring

The shelter afforded from wind, sea, and swell refers to the area where normal port operations are conducted, usually the wharf area. Shelter afforded by the anchorage area may be given for ports where cargo is handled by lighters. Values given are EXCELLENT, FAIR, GOOD, POOR, or NONE.

pilotReqdboolean

Flag indicating whether a pilot is required at this port.

latnumber double

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

lonnumber double

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

countryCodestring

The country where this port is located.

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.

origNetworkstring

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

Example response

[
  {
    "id": "026dd511-8ba5-47d3-9909-836149f87686",
    "classificationMarking": "U",
    "idSite": "a150b3ee-884b-b9ac-60a0-6408b4b16088",
    "externalId": "fe4ad5dc-0128-4ce8-b09c-0b404322025e",
    "locode": "CAVAN",
    "portName": "Vancouver",
    "harborType": "COASTAL NATURAL",
    "harborSize": 160.1,
    "maxDraught": 18.1,
    "avgDuration": 41.1,
    "tideRange": 4.1,
    "shelter": "EXCELLENT",
    "pilotReqd": true,
    "lat": 45.23,
    "lon": 179.1,
    "countryCode": "US",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "origNetwork": "OPS1"
  }
]

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_90 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.