BLbluestaq
Vessel

POST /udl/vessel

Changed on

Service operation to take a single vessel record as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/vessel
  • Auth
    none declared

Request body

idstring

Unique identifier of the record, auto-generated by the system.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

idEntitystring

Unique identifier of the parent entity. idEntity is required for Put.

altVesselIdstring

The original source Id for this vessel.

idOrganizationstring

The UDL ID of the organization that owns the vessel.

vesselNamestring

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.

vesselTypestring

The reported ship type (e.g. Passenger, Tanker, Cargo, Other, etc.).

vesselClassstring

The common name for a group of ships with similar design, usually named for the first vessel of the class.

vesselDescriptionstring

Further description or explanation of the vessel or type.

sconumstring

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.

imoninteger

The International Maritime Organization Number of the vessel. IMON is a seven-digit number that uniquely identifies the vessel.

mmsistring

The Maritime Mobile Service Identity of the vessel. MMSI is a nine-digit number that identifies the transmitter station of the vessel.

callsignstring

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.

vesselFlagstring

The flag of the subject vessel.

yearBuiltstring

Year the vessel went into service.

vesselBuilderstring

The shipbuilder who built this vessel.

statusstring

The status of this vessel.

firstSeenstring date-time

The date this vessel was first seen.

lengthnumber double

The overall length of the vessel, in meters. A value of 511 indicates a vessel length of 511 meters or greater.

widthnumber double

The breadth of the vessel, in meters. A value of 63 indicates a vessel breadth of 63 meters or greater.

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

vslWtnumber double

The weight in tons, of this vessel.

maxSpeednumber double

The maximum possible speed of this vessel in meters per second.

sternTypestring

The stern type code (Counter, Cruiser) associated with this vessel.

numBladesinteger

The number of blades per shaft for this vessel.

numShaftsinteger

The number of shafts on this vessel.

propTypestring

The type of propulsion employed by this vessel.

hullNumstring

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.

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 request

{
  "id": "0167f577-e06c-358e-85aa-0a07a730bdd0",
  "classificationMarking": "U",
  "entity": {
    "idEntity": "ENTITY-ID",
    "name": "Example name",
    "classificationMarking": "U",
    "type": "ONORBIT",
    "idLocation": "LOCATION-ID",
    "countryCode": "US",
    "ownerType": "Commercial",
    "urls": [
      "URL1",
      "URL2"
    ],
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "source": "Bluestaq",
    "origin": "THIRD_PARTY_DATASOURCE",
    "dataMode": "TEST",
    "location": {
      "idLocation": "LOCATION-ID",
      "classificationMarking": "U",
      "name": "Example location",
      "countryCode": "US",
      "lat": 45.23,
      "lon": 179.1,
      "altitude": 10.23,
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "origin": "THIRD_PARTY_DATASOURCE",
      "dataMode": "TEST",
      "origNetwork": "OPS1"
    },
    "onOrbit": {
      "idOnOrbit": "ONORBIT-ID",
      "classificationMarking": "U",
      "satNo": 1,
      "commonName": "Example common name",
      "constellation": "Big Dipper",
      "intlDes": "2021123ABC",
      "launchDate": "2018-01-01",
      "decayDate": "2018-01-01T16:00:00.123Z",
      "objectType": "PAYLOAD",
      "origin": "THIRD_PARTY_DATASOURCE",
      "missionNumber": "Expedition 1",
      "category": "Lunar",
      "lifetimeYears": 10,
      "altName": "Alternate Name",
      "createdAt": "2018-01-01T16:00:00.123Z",
      "createdBy": "some.user",
      "source": "Bluestaq",
      "dataMode": "TEST",
      "launchSiteId": "LAUNCHSITE-ID",
      "countryCode": "US",
      "origNetwork": "OPS1"
    },
    "idOnOrbit": "ONORBIT-ID",
    "idOperatingUnit": "OPERATINGUNIT-ID",
    "origNetwork": "OPS1"
  },
  "idEntity": "ENTITY-ID",
  "altVesselId": "590b5194fc32e75dd00682ba",
  "idOrganization": "0147f777-w09a-835f-85aa-0a07a730fgg0",
  "vesselName": "DORNUM",
  "vesselType": "Passenger",
  "vesselClass": "Nimitz",
  "vesselDescription": "Search and Rescue Vessel",
  "sconum": "B45524",
  "imon": 9566356,
  "mmsi": "416450000",
  "callsign": "V2OZ",
  "vesselFlag": "United States",
  "yearBuilt": "2014",
  "vesselBuilder": "Samsung Heavy Inds - Geoje",
  "status": "In Service/Commission",
  "firstSeen": "2018-01-01T16:00:00.123Z",
  "length": 511.1,
  "width": 24.1,
  "maxDraught": 21.1,
  "vslWt": 3423.76,
  "maxSpeed": 32.5,
  "sternType": "Cruiser",
  "numBlades": 4,
  "numShafts": 3,
  "propType": "Diesel",
  "hullNum": "A30081",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "dataMode": "TEST",
  "origNetwork": "OPS1"
}

Response

Success

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new LASEREMITTER enum value to the request property /

  • 75f764c843a9Revision changes
    • breaking

      request body became required

    • warning

      the // request property's maxLength was set to 4

    • warning

      the // request property's min was set to 0.00

    • info

      api operation id create_134 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.