API Reference

Update an existing ship

put
https://api.toqua.ai/ships/

All fields should be provided. Specify null to clear a field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
required

Ship design class.

string
enum
required
required
length between 2 and 2

Country of registration, in 2-letter ISO 3166-1 alpha-2 format.

required
1900 to 2026

Build year of the ship.

required
length ≤ 256

Shipyard where the ship was built.

required
0 to 1000000

Deadweight tonnage in metric tons.

required
0 to 30000

Twenty-foot Equivalent Unit capacity. Required for container ships.

required
0 to 1000000

Gross tonnage in metric tons. Required for cruise ships.

required
0 to 1000000

Cubic meters of cargo space. Required for gas tankers.

required
0 to 10000

Car Equivalent Unit capacity. Required for RoRo ships.

number
required
0 to 200

Beam in meters.

number
required
0 to 500

Length overall in meters.

required
0 to 200000

Maximum continuous rating in kW.

number
required
0 to 1
Defaults to 0.1

Minimum allowed load as a fraction of MCR (0-1). Predictions with power output below this threshold will be set to null. For example, 0.1 means 10% of MCR.

number
required
0 to 1
Defaults to 0.9

Maximum allowed load as a fraction of MCR (0-1). Predictions with power output above this threshold will be set to null. For example, 0.9 means 90% of MCR.

required
0 to 1000

Minimum speed of the propeller in RPM.

required
0 to 1000

Maximum speed of the propeller in RPM.

enum
boolean
Defaults to false

Whether the ship has a shaft generator installed.

boolean
Defaults to false

Whether the ship has a rotor sail installed.

boolean
Defaults to false

Whether the ship has an air lubrication system installed.

length ≤ 255

Free-text description of other propulsion technology installed on the ship.

required
0 to 50

Draft in meters when the ship is empty. The opposite of summer draft.

required
0 to 50

Draft in meters when the ship is fully loaded with cargo. The opposite of lightship draft.

Date and time when the ship was created.

shop_test_data

List of shop test data for the ship.

Responses

403

Forbidden

404

Not Found

501

Not Implemented

Updated 10 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago