Nemo Ship Database Service (1.0.0)

Download OpenAPI specification:

License: MIT

API for managing vessel data.

Vessel Management

Create ice class approval request to Traficom

Set ice class status PENDING and submit email to Traficom

Authorizations:

bearerAuth

path Parameters

esdId

required

string

The unique identifier for the ship.

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Request Body schema: application/json
required

requestIceClassConfirmation required	boolean Indicator that authorities should study ship certificates and approve new ice class
businessId required	string Business id of the requester's company
certificateIssueDate	string <date> The issue date of the certificate
certificateDateOfExpiry	string <date> The expiry date of the certificate
certificateIssuerCode	string The issuer code of the certificate
certificateIssuerTypeCode	string The type code of the certificate issuer
certificateIssuerName	string The name of the certificate issuer
certificateIssuerFlagStateCode	string The flag state code of the certificate issuer
visitId	string The visitId of the port call for which a certificate has been sent with the CRT formality. This information is required when requestIceClassConfirmation is false.
formalityId	string <uuid> The formalityId of the CRT formality. This information is required when when requestIceClassConfirmation is false.

Responses

Request samples

Payload

Content type

application/json

{"requestIceClassConfirmation": true,
"businessId": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string",
"visitId": "string",
"formalityId": "6b69b3cd-3bc7-4873-890f-da9ceb6f2b40"
}

Response samples

Content type

application/json

{"success": true,
"message": "string"
}

Delete ship certificate.

Delete certificate TM("International Tonnage Certificate"), REG("Certificate of Registry"), CL("Classification certificate"), LL("International Load Line Certificate or Exception"), ISPS(

Authorizations:

bearerAuth

path Parameters

esdId required	string The unique identifier for the ship.
certificateType required	string The unique identifier of the certificate.

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

{"errorCode": "string",
"errorMessage": "string"
}

Create or update ship certificate

Create or update certificate TM("International Tonnage Certificate"), REG("Certificate of Registry"), CL("Classification certificate"), LL("International Load Line Certificate or Exception"), ISPS(

Authorizations:

bearerAuth

path Parameters

esdId required	string The unique identifier for the ship.
certificateType required	string The unique identifier of the certificate.

query Parameters

sendNotificationEmail

boolean

Default: true

Whether to send notification email to authorities

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Request Body schema: application/json
required

attachmentId required	string <uuid> The unique identifier of the attachment
attachmentFileName required	string The file name of the attachment
attachmentNameCode required	string The code name of the attachment
certificateTypeCode required	string The type code of the certificate. Types: TM ('International Tonnage Certificate'), REG ('Certificate of Registry'),CL ('Classification certificate'), LL ('International Load Line Certificate or Exception'), ISPS ('International Ship Security Certificate or Interim International Ship Security Certificate') and OTHER ('Other type of certificate')
certificateDescription	string The description of the certificate. Required if certificateTypeCode is 'OTHER'
certificateIssueDate required	string <date> The issue date of the certificate
certificateDateOfExpiry required	string <date> The expiry date of the certificate
certificateIssuerCode required	string The issuer code of the certificate
certificateIssuerTypeCode required	string The type code of the certificate issuer
certificateIssuerName required	string The name of the certificate issuer
certificateIssuerFlagStateCode required	string The flag state code of the certificate issuer
visitId required	string The visitId of the port call for which a certificate has been sent with the CRT formality. This information is required when sending an email.
formalityId required	string <uuid> The formalityId of the CRT formality. This information is required when sending an email.

Responses

Request samples

Payload

Content type

application/json

{"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
"attachmentFileName": "string",
"attachmentNameCode": "string",
"certificateTypeCode": "string",
"certificateDescription": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string",
"visitId": "string",
"formalityId": "6b69b3cd-3bc7-4873-890f-da9ceb6f2b40"
}

Response samples

Content type

application/json

{"errorCode": "string",
"errorMessage": "string"
}

API

Get S3 presigned url for certificate download

Authorizations:

bearerAuth

path Parameters

esdId required	string The unique identifier for the ship.
attachmentId required	string The unique s3 identifier for attachment.

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

{"errorCode": "string",
"errorMessage": "string"
}

Scan attachment for viruses and move to archive

Authorizations:

bearerAuth

path Parameters

esdId required	string The unique identifier for the ship.
attachmentId required	string The unique s3 identifier for attachment.

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

{"errorCode": "string",
"errorMessage": "string"
}

Certificates

Get S3 presigned url for certificate upload

Authorizations:

bearerAuth

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

{"url": "string",
"objectKey": "string"
}

Integrations API

Get for a list of ships by imoId

Authorizations:

bearerAuth

path Parameters

imoId

required

string

Example: 9220330

A ship’s permanent identification number in international maritime transport.

Responses

Response samples

Content type

application/json

[{"activeShipData": {"ESDId": "ESDID7532159875",
"logisticsTransportMovement": {"usedTransportMeans": {"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
}
},
"activeExemptions": [{"exemptionId": "GR345349304FG234",
"exemptionDetails": {"exemptionType": "Pre-Arrival",
"dateFrom": 19925,
"dateTo": 19956,
"routes": [{"port": "GRPIR"
}
],
"exemptedWasteTypes": [{"wasteCode": "506",
"wasteDescription": "Operational wastes"
}
],
"exemptionAppliesTo": [{"port": "NLRTM",
"exemptedPortFacilities": [{"portFacilityCode": null
}
]
}
],
"authority": {"country": "GR",
"authorityType": "POR",
"authorityName": "Port of Heraklion"
},
"contract247": {"contactName": "John Doe",
"loCode": "GRHER",
"phoneNumber": "+302810000000",
"email": "john.doe@example.com"
}
}
}
]
},
"iceClass": {"status": "string",
"code": "string",
"entryDate": "2019-08-24",
"validTo": "2019-08-24",
"dateOfIssue": "2019-08-24",
"requestedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"certificates": [{"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
"attachmentFileName": "string",
"attachmentNameCode": "string",
"certificateTypeCode": "string",
"certificateDescription": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string"
}
]
}
]

Ship API

Get single ship by ESDId

Authorizations:

bearerAuth

path Parameters

esdId

required

string

The ESDId (e.g. ESDID1234567890) of the ship

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

{"activeShipData": {"ESDId": "ESDID7532159875",
"logisticsTransportMovement": {"usedTransportMeans": {"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
}
},
"activeExemptions": [{"exemptionId": "GR345349304FG234",
"exemptionDetails": {"exemptionType": "Pre-Arrival",
"dateFrom": 19925,
"dateTo": 19956,
"routes": [{"port": "GRPIR"
}
],
"exemptedWasteTypes": [{"wasteCode": "506",
"wasteDescription": "Operational wastes"
}
],
"exemptionAppliesTo": [{"port": "NLRTM",
"exemptedPortFacilities": [{"portFacilityCode": "NLRTM-0406"
}
]
}
],
"authority": {"country": "GR",
"authorityType": "POR",
"authorityName": "Port of Heraklion"
},
"contract247": {"contactName": "John Doe",
"loCode": "GRHER",
"phoneNumber": "+302810000000",
"email": "john.doe@example.com"
}
}
}
]
},
"iceClass": {"status": "string",
"code": "string",
"entryDate": "2019-08-24",
"validTo": "2019-08-24",
"dateOfIssue": "2019-08-24",
"requestedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"certificates": [{"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
"attachmentFileName": "string",
"attachmentNameCode": "string",
"certificateTypeCode": "string",
"certificateDescription": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string"
}
]
}

Search ships

Authorizations:

bearerAuth

query Parameters

required

string

Search by ESD ID, ship name, imo number, mmsi number or call sign

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

[{"ESDId": "ESDID7532159875",
"logisticsTransportMovement": {"usedTransportMeans": {"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
}
},
"activeExemptions": [{"exemptionId": "GR345349304FG234",
"exemptionDetails": {"exemptionType": "Pre-Arrival",
"dateFrom": 19925,
"dateTo": 19956,
"routes": [{"port": "GRPIR"
}
],
"exemptedWasteTypes": [{"wasteCode": "506",
"wasteDescription": "Operational wastes"
}
],
"exemptionAppliesTo": [{"port": "NLRTM",
"exemptedPortFacilities": [{"portFacilityCode": "NLRTM-0406"
}
]
}
],
"authority": {"country": "GR",
"authorityType": "POR",
"authorityName": "Port of Heraklion"
},
"contract247": {"contactName": "John Doe",
"loCode": "GRHER",
"phoneNumber": "+302810000000",
"email": "john.doe@example.com"
}
}
}
]
}
]

Search ships by query parameter

Authorizations:

bearerAuth

query Parameters

esdId	string Partial or exact match on ESDId
callSignId	string Partial or exact match on the callSignId
imoId	string Filter by ImoId
name	string Partial or exact match on the vessel name
cfrId	string Partial or exact match on the CFR Id
eniId	string Partial or exact match on the ENI Id
mmsiId	string Partial or exact match on the MMSI Id
otherId	string Partial or exact match on the Other ID

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Responses

Response samples

Content type

application/json

[{"activeShipData": {"ESDId": "ESDID7532159875",
"logisticsTransportMovement": {"usedTransportMeans": {"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
}
},
"activeExemptions": [{"exemptionId": "GR345349304FG234",
"exemptionDetails": {"exemptionType": "Pre-Arrival",
"dateFrom": 19925,
"dateTo": 19956,
"routes": [{"port": "GRPIR"
}
],
"exemptedWasteTypes": [{"wasteCode": "506",
"wasteDescription": "Operational wastes"
}
],
"exemptionAppliesTo": [{"port": "NLRTM",
"exemptedPortFacilities": [{"portFacilityCode": null
}
]
}
],
"authority": {"country": "GR",
"authorityType": "POR",
"authorityName": "Port of Heraklion"
},
"contract247": {"contactName": "John Doe",
"loCode": "GRHER",
"phoneNumber": "+302810000000",
"email": "john.doe@example.com"
}
}
}
]
},
"iceClass": {"status": "string",
"code": "string",
"entryDate": "2019-08-24",
"validTo": "2019-08-24",
"dateOfIssue": "2019-08-24",
"requestedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"certificates": [{"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
"attachmentFileName": "string",
"attachmentNameCode": "string",
"certificateTypeCode": "string",
"certificateDescription": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string"
}
]
}
]

V2 Vessel Management

Create ice class approval request to Traficom

Set ice class status PENDING and submit email to Traficom

Authorizations:

bearerAuth

path Parameters

vesselId

required

string

The unique identifier for the ship.

header Parameters

organizationBusinessId

required

string

The business ID (y-tunnus) of the organization (default is empty string for virtu users)

Request Body schema: application/json
required

requestIceClassConfirmation required	boolean Indicator that authorities should study ship certificates and approve new ice class
businessId required	string Business id of the requester's company
certificateIssueDate	string <date> The issue date of the certificate
certificateDateOfExpiry	string <date> The expiry date of the certificate
certificateIssuerCode	string The issuer code of the certificate
certificateIssuerTypeCode	string The type code of the certificate issuer
certificateIssuerName	string The name of the certificate issuer
certificateIssuerFlagStateCode	string The flag state code of the certificate issuer
visitId	string The visitId of the port call for which a certificate has been sent with the CRT formality. This information is required when requestIceClassConfirmation is false.
formalityId	string <uuid> The formalityId of the CRT formality. This information is required when when requestIceClassConfirmation is false.

Responses

Request samples

Payload

Content type

application/json

{"requestIceClassConfirmation": true,
"businessId": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string",
"visitId": "string",
"formalityId": "6b69b3cd-3bc7-4873-890f-da9ceb6f2b40"
}

Response samples

Content type

application/json

{"success": true,
"message": "string"
}

V2 internal

Internal use only. Search ships from portnetdump

Search ship from portnetdata dump. This will be deprecated in the future.

Authorizations:

bearerAuth

query Parameters

name	string
imoid	string
callsignid	string

Responses

Response samples

Content type

application/json

[{"VESSEL_NME": "string",
"VESSEL_SEARCH_NME": "string",
"vessel_nme_prefix": "string",
"VESSEL_CALLSIGN": "string",
"VESSEL_RCS_TYPE": "string",
"VESSEL_IMO_LLOYDS": "string",
"VESSEL_MMSI": 0,
"VESSEL_NAT_CDE": "string",
"VESSEL_HOMEST_COD": 0,
"VESSEL_HOME_CTY": "string",
"vessel_homest_nme": "string",
"VESSEL_TYPE_CDE": "string",
"vessel_iceclass_cde": "string",
"VESSEL_ICECLASS_DTE": "string",
"VESSEL_ICECLASS_CTY": "string",
"VESSEL_CLASSIF_CDE": "string",
"VESSEL_MATERIAL": "string",
"VESSEL_DOUBLEHULL_BOL": "string",
"VESSEL_INERTSYST_BOL": "string",
"VESSEL_SBSYS_BOL": "string",
"VESSEL_BOOK_CONSIG": "string",
"VESSEL_BOOK_DTE": "string",
"VESSEL_GROSS_TON": 0,
"VESSEL_NET_TON": 0,
"VESSEL_DWT_QTY": 0,
"VESSEL_LENGTH_DEC": "string",
"VESSEL_LENGTH_MAX_DEC": "string",
"VESSEL_HEIGHT_DEC": "string",
"VESSEL_BEAM_DEC": "string",
"VESSEL_DRAUGHT_DEC": "string",
"VESSEL_SPEED_DEC": "string",
"VESSEL_ENGPOWER_QTY": "string",
"VESSEL_TOTAL_POWER": 0,
"VESSEL_PERSON_MAX": 0,
"VESSEL_PASSENGER_MAX": 0,
"VESSEL_KEEL_DTE": "string",
"VESSEL_REGSHIP_COD": "string",
"VESSEL_DSC": "string",
"VESSEL_SIMPTRA_COD": "string",
"VESSEL_OWNER_NME": "string",
"VESSEL_REMOVAL_DTE": "string",
"VESSEL_PHO": "string",
"VESSEL_FAX": "string",
"VESSEL_CUSTOM_PASS_DTE": "string",
"VESSEL_DATACONF": "string",
"VESSEL_UTS": 0,
"VESSEL_UUI": "string",
"VESSEL_PHO2": "string",
"VESSEL_FAX2": "string",
"SHIP_UTS": 0,
"VESSEL_ICECLASS_EDT": "string",
"VESSEL_SAFETY_DECL_EXEMPT_BOL": "string",
"VESSEL_SAFETY_SERT_AUTH_NME": "string",
"VESSEL_SAFETY_SERT_SDT": "string",
"VESSEL_SAFETY_SERT_EDT": "string",
"VESSEL_SAFETY_SERT_CHECK_DTE": "string",
"VESSEL_PROV_ACCOUNTABILITY_BOL": "string",
"VESSEL_CUSTOMS_TYPE_CDE": "string",
"VESSEL_EML": "string",
"VESSEL_OWNER_IMO": "string",
"VESSEL_INMARSAT_PHO": "string"
}
]

V2 Ships

Search ships (v2)

Authorizations:

bearerAuth

query Parameters

name	string
imoid	string
callsignid	string

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"updated": "2019-08-24T14:15:22Z",
"name": "string",
"imoid": "string",
"eni": "string",
"cfr": "string",
"callsignid": "string",
"otherid": "string",
"mmsiid": "string",
"flagstate": "string",
"vesseltype": "string",
"length": "string",
"width": "string",
"registrationcountry": "string",
"grossweight": 0.1,
"netweight": 0.1,
"dwt": 0.1
}
]

Create a new Ship

Create a new Ship with the provided data.

Authorizations:

bearerAuth

Request Body schema: application/json
required

required	object or null (ShipId) Details of the ship ID.
required	object (ShipData) Additional data about the ship.

Responses

Request samples

Payload

Content type

application/json

{"shipId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"callsignid": "string",
"mmsid": "string",
"imoid": "string",
"eniid": "string",
"cfrid": "string",
"otherid": "string",
"esdid": "string"
},
"shipData": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flagstate": "GR",
"registrationcountry": "GR",
"length": 150.42,
"width": 13.45,
"grossweight": 345.541,
"netweight": 200,
"dwt": 550.427,
"typeCode": 8454,
"related_transport_mode": "string",
"external_marking_text": "string",
"ice_class_code": "string",
"main_engine_availability_indicator": true,
"summer_draught": 0.1,
"fresh_water_draught": 0.1,
"between_perpendiculars_length": 0.1,
"open_water_speed_measure": 0.1,
"navigation_type_code": "string",
"reduced_gross_tonnage": 0.1,
"operator_name": "string",
"owner_name": "string",
"owner_registered_id": "string",
"owner_postcode": "string",
"owner_street": "string",
"owner_city": "string",
"owner_country_code": "string",
"pni_club_name": "string",
"satellite_id": "string",
"satellite_provider_code": "string",
"charterer_type_code": "string",
"charterer_name": "string",
"charterer_postcode": "string",
"charterer_street": "string",
"charterer_city": "string",
"charterer_country_code": "string",
"ship_drive_type_code": "string",
"bow_thruster_power": 0.1,
"stern_thruster_power": 0.1,
"customs_checked": true
}
}

Response samples

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"deleted": "2019-08-24T14:15:22Z",
"name": "string",
"imoid": "string",
"callsignid": "string",
"mmsiid": "string",
"registrationcountry": "string",
"typecode": "string",
"iceclasscode": "string",
"grossweight": 0.1,
"netweight": 0.1
}

Modify a new Ship

Modify ship a new Ship with the provided data.

Authorizations:

bearerAuth

Request Body schema: application/json
required

required	object or null (ShipId) Details of the ship ID.
required	object (ShipData) Additional data about the ship.

Responses

Request samples

Payload

Content type

application/json

{"shipId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"callsignid": "string",
"mmsid": "string",
"imoid": "string",
"eniid": "string",
"cfrid": "string",
"otherid": "string",
"esdid": "string"
},
"shipData": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flagstate": "GR",
"registrationcountry": "GR",
"length": 150.42,
"width": 13.45,
"grossweight": 345.541,
"netweight": 200,
"dwt": 550.427,
"typeCode": 8454,
"related_transport_mode": "string",
"external_marking_text": "string",
"ice_class_code": "string",
"main_engine_availability_indicator": true,
"summer_draught": 0.1,
"fresh_water_draught": 0.1,
"between_perpendiculars_length": 0.1,
"open_water_speed_measure": 0.1,
"navigation_type_code": "string",
"reduced_gross_tonnage": 0.1,
"operator_name": "string",
"owner_name": "string",
"owner_registered_id": "string",
"owner_postcode": "string",
"owner_street": "string",
"owner_city": "string",
"owner_country_code": "string",
"pni_club_name": "string",
"satellite_id": "string",
"satellite_provider_code": "string",
"charterer_type_code": "string",
"charterer_name": "string",
"charterer_postcode": "string",
"charterer_street": "string",
"charterer_city": "string",
"charterer_country_code": "string",
"ship_drive_type_code": "string",
"bow_thruster_power": 0.1,
"stern_thruster_power": 0.1,
"customs_checked": true
}
}

Response samples

Content type

application/json

{"success": true,
"message": "string"
}

Search ship id's

Authorizations:

bearerAuth

query Parameters

name	string
callsignid	string
mmsid	string
imoid	string
eniid	string
cfrid	string
otherid	string

header Parameters

organizationBusinessId

required

string

Responses

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"callsignid": "string",
"mmsid": "string",
"imoid": "string",
"eniid": "string",
"cfrid": "string",
"otherid": "string",
"esdid": "string"
}
]

Search ship id's

Authorizations:

bearerAuth

query Parameters

queryparameter

required

string

Responses

Response samples

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"callsignid": "string",
"mmsid": "string",
"imoid": "string",
"eniid": "string",
"cfrid": "string",
"otherid": "string",
"esdid": "string"
}
]

Get ship by UUID (v2)

Authorizations:

bearerAuth

path Parameters

uuid

required

string <uuid>

header Parameters

organizationBusinessId

required

string

Responses

Response samples

Content type

application/json

{"shipId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"callsignid": "string",
"mmsid": "string",
"imoid": "string",
"eniid": "string",
"cfrid": "string",
"otherid": "string",
"esdid": "string"
},
"shipData": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flagstate": "GR",
"registrationcountry": "GR",
"length": 150.42,
"width": 13.45,
"grossweight": 345.541,
"netweight": 200,
"dwt": 550.427,
"typeCode": 8454,
"related_transport_mode": "string",
"external_marking_text": "string",
"ice_class_code": "string",
"main_engine_availability_indicator": true,
"summer_draught": 0.1,
"fresh_water_draught": 0.1,
"between_perpendiculars_length": 0.1,
"open_water_speed_measure": 0.1,
"navigation_type_code": "string",
"reduced_gross_tonnage": 0.1,
"operator_name": "string",
"owner_name": "string",
"owner_registered_id": "string",
"owner_postcode": "string",
"owner_street": "string",
"owner_city": "string",
"owner_country_code": "string",
"pni_club_name": "string",
"satellite_id": "string",
"satellite_provider_code": "string",
"charterer_type_code": "string",
"charterer_name": "string",
"charterer_postcode": "string",
"charterer_street": "string",
"charterer_city": "string",
"charterer_country_code": "string",
"ship_drive_type_code": "string",
"bow_thruster_power": 0.1,
"stern_thruster_power": 0.1,
"customs_checked": true
},
"UsedTransportMeans": {"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
},
"ShipV2": {"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"deleted": "2019-08-24T14:15:22Z",
"name": "string",
"imoid": "string",
"callsignid": "string",
"mmsiid": "string",
"registrationcountry": "string",
"typecode": "string",
"iceclasscode": "string",
"grossweight": 0.1,
"netweight": 0.1
},
"ShipCertificates": [{"attachmentId": "96b9bbac-86d3-4497-9e0c-1f8e3803eddb",
"attachmentFileName": "string",
"attachmentNameCode": "string",
"certificateTypeCode": "string",
"certificateDescription": "string",
"certificateIssueDate": "2019-08-24",
"certificateDateOfExpiry": "2019-08-24",
"certificateIssuerCode": "string",
"certificateIssuerTypeCode": "string",
"certificateIssuerName": "string",
"certificateIssuerFlagStateCode": "string"
}
]
}

Get ship history (v2)

Authorizations:

bearerAuth

query Parameters

datefrom required	string <date> Start date for the history query (inclusive)
dateto required	string <date> End date for the history query (inclusive)

Responses

Response samples

Content type

application/json

[{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"updated": "2019-08-24T14:15:22Z",
"name": "string",
"imoid": "string",
"eni": "string",
"cfr": "string",
"callsignid": "string",
"otherid": "string",
"mmsiid": "string",
"flagstate": "string",
"vesseltype": "string",
"length": "string",
"width": "string",
"registrationcountry": "string",
"grossweight": 0.1,
"netweight": 0.1,
"dwt": 0.1
}
]

V2 Ships EMSA

Get ship by UUID (v2)

Authorizations:

bearerAuth

path Parameters

uuid

required

string <uuid>

Responses

Response samples

Content type

application/json

{"callSignId": "SVDJ4",
"name": "Knossos Palace",
"IMONumberIndicator": true,
"IMOId": "9220330",
"MMSIId": "051726000",
"ENIId": "47000279",
"CFRId": "ESP000015003",
"otherId": "FOO123BAR",
"typeCode": 8454,
"grossWeight": 34.541,
"netWeight": 34.541,
"relatedTransportMode": 8,
"externalMarkingText": "CHRISTINA",
"widthMeasure": 13.45,
"ICEClassCode": "FS1A",
"mainEngineAvailabilityIndicator": true,
"deadWeightTonnage": 550.427,
"summerDraught": 10.2,
"freshWaterDraught": 10.2,
"reducedGrossWeight": 50234.8,
"overallLength": 150.42,
"betweenPerpendicularsLength": 20.2,
"openWaterSpeedMeasure": 16.4,
"registrationCountry": {"code": "GR"
},
"operator": {"name": "ACME SA"
},
"owner": {"name": "Combine Honnete Ober Advancer Mercantiles (CHOAM)",
"registeredId": "0123456",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"applicableMembership": {"applicableMembershipLegalOrganisation": {"name": "The Britannia Steam Ship Insurance Association Limited"
}
}
},
"registrationEvent": {"id": "TX7394",
"actualOccurrenceDate": "2024-07-21",
"occurrenceLocation": {"id": "GRPIR",
"name": "PIRAEUS PORT GREECE"
},
"certifyingParty": {"id": "GB02"
}
},
"specifiedSatelliteIdentification": [{"id": 424404310,
"providerCode": 1
}
],
"shipCompanyParty": {"id": "4567897",
"name": "Atlantic Transports",
"registeredId": "FE83475948J",
"shipCompanySMDGCode": "HDS",
"taxId": "436FDS5342",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
},
"telephone": [{"completeNumber": "00302105974315"
}
],
"emailAddress": [{"uri": "transport@example.com"
}
]
},
"chartererParty": {"typeCode": "BAREBOAT",
"name": "ACME SA",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"vesselCharacteristic": {"tankerHullConfigurationCode": "SHT",
"forwardToManifoldFullyLoadedParallelMeasure": 21.12,
"forwardToManifoldInBallastParallelMeasure": 21.12,
"aftToManifoldLoadedParallelMeasure": 21.12,
"aftToManifoldInBallastParallelMeasure": 21.12,
"bodyLengthParallelMeasure": 24.12,
"bowToBridgeMeasure": 5.25,
"sternToBridgeMeasure": 15.25,
"rudderSurfaceAreaMeasure": 7.84,
"windageSurfaceAreaMeasure": 15.15,
"summerDeadweightTonnage": 12000,
"maximumTEUCapacityQuantity": 6000,
"mastHeightMeasure": 64.25,
"depthMeasure": 24.25,
"displacementMeasure": 4800,
"keelToMastLengthMeasure": 14.25,
"segregatedBallastTankQuantity": 12,
"tankQuantity": 32,
"largestTankVolumeMeasure": 12541.24,
"winchQuantity": 10,
"inertGasSystemIndicator": true,
"bulbousBowIndicator": true,
"cargoHandlingGearDetails": "25 tons hydraulic crane",
"onboardShorePowerConnectionIndicator": true,
"thrusterIndicator": true,
"mainEngineQuantity": 1,
"auxiliaryEngineQuantity": 1,
"propellerQuantity": 2,
"bowThrusterQuantity": 2,
"sternThrusterQuantity": 2,
"rudderQuantity": 2,
"constructionBuilding": {"constructionDate": "2024-07-21",
"description": "Movable decks on 40mm rails",
"contractDate": "2024-07-21",
"keelLayingDate": "2024-07-21"
},
"specifiedMooringWinch": [{"locationCode": "MIDSHIP",
"descriptionText": "Automatic tensioning electric 4 split drum winch.",
"weightMeasure": 12.1
}
],
"onboardPropeller": [{"typeCode": 3,
"locationCode": "STARBOARD",
"powerMeasure": 12000.2,
"variablePitchIndicator": true,
"pitchRotationCode": "RIGHT",
"driveTypeCode": "DRV-02"
}
],
"onboardThruster": [{"bowPowerMeasure": 3730,
"sternPowerMeasure": 3730
}
],
"onboardTank": {"segregatedBallastTotalVolumeMeasure": 4332.15,
"totalCapacityVolumeMeasure": 40332.15
},
"onboardVesselRamp": {"widthMeasure": 5.2,
"locationCode": "PORT",
"extentMeasure": 8.5
},
"applicableMarineGreenCredential": {"sewageSystemTreatmentText": "Sludge water treatment",
"exhaustGasCleaningSystemIndicator": true,
"scrubberSystemIndicator": true,
"scrubberSystemTypeCode": "SCR-03",
"IGFRegulatoryRequirementIndicator": true,
"NOxReductionSystemDescriptionText": "Selective Catalytic Reduction (SCR)",
"wasteIncineratorIndicator": true,
"wasteIncineratorDescriptionText": "Vertical cyclone incinerator of 20 cubic meters capacity"
}
},
"onboardMainEngine": [{"typeCode": "ENG-03",
"powerMeasure": 84420,
"exhaustEmissionClassCode": 2,
"latestTestDate": "2024-07-21",
"fullCargoSpeedMeasure": 17.4,
"inBallastSpeedMeasure": 11.9,
"engineTierTypeCode": "II",
"engineIGFIndicator": true,
"sequenceNumber": 3,
"manufacturerParty": {"name": "MAN"
}
}
],
"onboardAuxiliaryEngine": [{"sequenceNumber": 3,
"powerMeasure": 1000,
"engineTierTypeCode": "II",
"engineIGFIndicator": true
}
],
"commercialManagerParty": {"name": "Jane Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
},
"technicalManagerParty": {"name": "John Doe",
"postalAddress": {"postCode": 73100,
"lineOne": "3rd Ave. 23",
"cityName": "Kaitain",
"countryCode": "string"
}
}
}

V2 Documents

Upload a PDF document bound to the Ship (v2)

Authorizations:

bearerAuth

path Parameters

uuid

required

string <uuid>

Request Body schema: multipart/form-data
required

file

required

string <binary>

Responses

Upload an additional JSON document bound to the Ship (v2)

Authorizations:

bearerAuth

path Parameters

uuid

required

string <uuid>

Request Body schema: application/json
required

object

Arbitrary JSON document associated with the ship

Responses

Request samples

Payload

Content type

application/json

{ }

Nemo Ship Database Service (1.0.0)

Vessel Management

Create ice class approval request to Traficom

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete ship certificate.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create or update ship certificate

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

API

Get S3 presigned url for certificate download

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Scan attachment for viruses and move to archive

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Certificates

Get S3 presigned url for certificate upload

Authorizations:

header Parameters

Responses

Response samples

Integrations API

Get for a list of ships by imoId

Authorizations:

path Parameters

Responses

Response samples

Ship API

Get single ship by ESDId

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Search ships

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Search ships by query parameter

Authorizations:

query Parameters

header Parameters

Responses

Response samples

V2 Vessel Management

Create ice class approval request to Traficom

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

V2 internal

Internal use only. Search ships from portnetdump

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
required