POST api/v{version}/Vessels/Update?updateDetailsOnly={updateDetailsOnly}

Updates a vessel.

Request Information

URI Parameters

Name	Description	Type	Additional information
updateDetailsOnly	If true, only vessel details (name and identifier) will be updated. If false, the operational constraints of the vessel will also be updated.	boolean	Required
version		string	None.

Body Parameters

The vessel to update.

VesselChanged

Name	Description	Type	Additional information
OperationalThresholdsGroups	A list of locations at which the vessel has operational constraints and the thresholds which apply at each location.	Collection of VesselThresholdsGroup	Required
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

Request Formats

application/json, text/json

Sample:

{
  "OperationalThresholdsGroups": [
    {
      "Id": 1,
      "Asset": {
        "Id": 1
      },
      "OperationTemplate": null,
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 1.5,
          "IsIgnored": false
        },
        {
          "Variable": {
            "Id": 2
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 5.0,
          "IsIgnored": false
        }
      ],
      "ForecastPoints": [
        {
          "Id": 10
        }
      ]
    },
    {
      "Id": 2,
      "Asset": {
        "Id": 2
      },
      "OperationTemplate": null,
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 2.0,
          "IsIgnored": false
        }
      ],
      "ForecastPoints": [
        {
          "Id": 3
        }
      ]
    }
  ],
  "Id": 1,
  "Name": "Vessel 1",
  "Identifier": "Vessel 1"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.