---
title: "GET /udl/port"
method: GET
path: "/udl/port"
tags: ["Site"]
---

# GET /udl/port

`GET /udl/port`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/udl/port`
- Auth: none declared

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.

## Query parameters

- `firstResult` integer
- `maxResults` integer

## Response `200`

OK

- PortAbridged[]
  - `id` string: Unique identifier of the record, auto-generated by the system if not provided on create operations.
  - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format.
  - `idSite` string: Unique identifier of the Site Entity associated with the Port record.
  - `externalId` string: 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.
  - `locode` string: 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.
  - `portName` string: The name of this port.
  - `harborType` string: 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).
  - `harborSize` number, double: The size of the harbor for this port measured in square kilometers.
  - `maxDraught` number, 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.
  - `avgDuration` number, double: Average time for a vessel at this port in hours.
  - `tideRange` number, double: The tide range of this port in meters.
  - `shelter` string: 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.
  - `pilotReqd` boolean: Flag indicating whether a pilot is required at this port.
  - `lat` number, double: WGS84 latitude of the location, in degrees. -90 to 90 degrees (negative values south of equator).
  - `lon` number, double: WGS84 longitude of the location, in degrees. -180 to 180 degrees (negative values west of Prime Meridian).
  - `countryCode` string: The country where this port is located.
  - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system.
  - `createdBy` string: Application user who created the row in the database, auto-populated by the system.
  - `source` string, required: Source of the data.
  - `origin` string: 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.
  - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system.

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `405`: Method Not Allowed
- `406`: MediaType Not Accepted by Request Headers
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-05-29** `4e1cbc17e814`: 2 info
  - added the new optional `query` request parameter `firstResult`
  - added the new optional `query` request parameter `maxResults`
- **2025-04-16** `75f764c843a9`: 2 info
  - api operation id `findAll_90` removed and replaced with ``
  - the endpoint scheme security `BasicAuth` was removed from the API

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/port/get.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)