--- title: "GET /udl/vessel" method: GET path: "/udl/vessel" tags: ["Vessel"] --- # GET /udl/vessel `GET /udl/vessel` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/vessel` - 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//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `firstResult` integer - `maxResults` integer ## Response `200` OK - VesselAbridged[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `idEntity` string: Unique identifier of the parent entity. idEntity is required for Put. - `altVesselId` string: The original source Id for this vessel. - `idOrganization` string: The UDL ID of the organization that owns the vessel. - `vesselName` string: The name of this vessel. Vessel names that exceed the AIS 20 character are shortened (not truncated) to 15 character-spaces, followed by an underscore and the last 4 characters-spaces of the vessel full name. - `vesselType` string: The reported ship type (e.g. Passenger, Tanker, Cargo, Other, etc.). - `vesselClass` string: The common name for a group of ships with similar design, usually named for the first vessel of the class. - `vesselDescription` string: Further description or explanation of the vessel or type. - `sconum` string: The Ship Control Number (SCONUM) is a naval vessel identification number (alphanumeric code) assigned by the Office of Naval Intelligence. SCONUM is sometimes referred to as NOIC ID. SCONUMs are typically of the form A#####, where A is an alpha character and # is numerical. - `imon` integer: The International Maritime Organization Number of the vessel. IMON is a seven-digit number that uniquely identifies the vessel. - `mmsi` string: The Maritime Mobile Service Identity of the vessel. MMSI is a nine-digit number that identifies the transmitter station of the vessel. - `callsign` string: A uniquely designated identifier for the vessel's transmitter station. All radio transmissions must be individually identified by the call sign. Merchant and naval vessels are assigned call signs by their national licensing authorities. - `vesselFlag` string: The flag of the subject vessel. - `yearBuilt` string: Year the vessel went into service. - `vesselBuilder` string: The shipbuilder who built this vessel. - `status` string: The status of this vessel. - `firstSeen` string, date-time: The date this vessel was first seen. - `length` number, double: The overall length of the vessel, in meters. A value of 511 indicates a vessel length of 511 meters or greater. - `width` number, double: The breadth of the vessel, in meters. A value of 63 indicates a vessel breadth of 63 meters or greater. - `maxDraught` number, double: The maximum static draught, in meters, of the vessel defined as the distance between the ship’s keel and the waterline of the vessel. - `vslWt` number, double: The weight in tons, of this vessel. - `maxSpeed` number, double: The maximum possible speed of this vessel in meters per second. - `sternType` string: The stern type code (Counter, Cruiser) associated with this vessel. - `numBlades` integer: The number of blades per shaft for this vessel. - `numShafts` integer: The number of shafts on this vessel. - `propType` string: The type of propulsion employed by this vessel. - `hullNum` string: The vessel hull number designation of this maritime vessel. The hull number is a 1-6 character alphanumeric entry assigned to a ship and painted on the hull. - `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_135` 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/vessel/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)