GET api/v{version}/Vessels

Gets all vessels in the user's current project.

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

A list of the vessels in the project.

Collection of Vessel

Name	Description	Type	Additional information
Id	The ID of the vessel.	integer	Required
Name	The name of the vessel.	string	Required String length: inclusive between 0 and 100
Identifier	A name for the vessel that must be unique for each vessel in a project.	string	Required String length: inclusive between 0 and 100
OperationalThresholdsGroups	A list of locations at which the vessel has operational constraints and the thresholds which apply at each location.	Collection of VesselThresholdsGroup	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "Vessel 1",
    "Identifier": "Vessel 1",
    "OperationalThresholdsGroups": [
      {
        "Id": 1,
        "Asset": {
          "Id": 1,
          "Name": "Port",
          "Identifier": "Asset 1",
          "Latitude": 0.0,
          "Longitude": 1.0,
          "ForecastPoint": {
            "Id": 10,
            "Name": "Forecast point 10",
            "Latitude": 0.0,
            "Longitude": 1.0
          }
        },
        "OperationTemplate": null,
        "IsWeatherDependent": true,
        "Thresholds": [
          {
            "Variable": {
              "Id": 1,
              "Name": "Significant wave height",
              "Units": "m",
              "IsDirection": false,
              "IsBelowThresholdSuccess": true
            },
            "MinThresholdValue": null,
            "MaxThresholdValue": 1.5,
            "IsIgnored": false
          },
          {
            "Variable": {
              "Id": 2,
              "Name": "Wave period",
              "Units": "secs",
              "IsDirection": false,
              "IsBelowThresholdSuccess": true
            },
            "MinThresholdValue": null,
            "MaxThresholdValue": 5.0,
            "IsIgnored": false
          }
        ],
        "ForecastPoints": [
          {
            "Id": 10,
            "Name": "Forecast point 10",
            "Latitude": 0.0,
            "Longitude": 1.0
          }
        ]
      },
      {
        "Id": 2,
        "Asset": {
          "Id": 2,
          "Name": "A1",
          "Identifier": "Asset 2",
          "Latitude": 1.0,
          "Longitude": 0.0,
          "ForecastPoint": {
            "Id": 3,
            "Name": "Forecast point 3",
            "Latitude": 1.1,
            "Longitude": 0.0
          }
        },
        "OperationTemplate": null,
        "IsWeatherDependent": true,
        "Thresholds": [
          {
            "Variable": {
              "Id": 1,
              "Name": "Significant wave height",
              "Units": "m",
              "IsDirection": false,
              "IsBelowThresholdSuccess": true
            },
            "MinThresholdValue": null,
            "MaxThresholdValue": 2.0,
            "IsIgnored": false
          }
        ],
        "ForecastPoints": [
          {
            "Id": 3,
            "Name": "Forecast point 3",
            "Latitude": 1.1,
            "Longitude": 0.0
          }
        ]
      }
    ]
  },
  {
    "Id": 2,
    "Name": "Vessel 2",
    "Identifier": "Vessel 2",
    "OperationalThresholdsGroups": [
      {
        "Id": 1,
        "Asset": {
          "Id": 1,
          "Name": "Port",
          "Identifier": "Asset 1",
          "Latitude": 0.0,
          "Longitude": 1.0,
          "ForecastPoint": {
            "Id": 10,
            "Name": "Forecast point 10",
            "Latitude": 0.0,
            "Longitude": 1.0
          }
        },
        "OperationTemplate": null,
        "IsWeatherDependent": true,
        "Thresholds": [
          {
            "Variable": {
              "Id": 1,
              "Name": "Significant wave height",
              "Units": "m",
              "IsDirection": false,
              "IsBelowThresholdSuccess": true
            },
            "MinThresholdValue": null,
            "MaxThresholdValue": 1.7,
            "IsIgnored": false
          }
        ],
        "ForecastPoints": [
          {
            "Id": 10,
            "Name": "Forecast point 10",
            "Latitude": 0.0,
            "Longitude": 1.0
          }
        ]
      }
    ]
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.