POST api/v{version}/Vessels

Creates a vessel in the user's current project.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

The vessel to create.

VesselNew
NameDescriptionTypeAdditional information
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 items representing the operational constraints of the vessel at various locations.

 Collection of VesselThresholdsGroup

Required

Request Formats

application/json, text/json

Sample: 
{
  "Name": "Vessel 1",
  "Identifier": "Vessel 1",
  "OperationalThresholdsGroups": [
    {
      "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
        }
      ]
    },
    {
      "Asset": {
        "Id": 2
      },
      "OperationTemplate": null,
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 2.0,
          "IsIgnored": false
        }
      ],
      "ForecastPoints": [
        {
          "Id": 3
        }
      ]
    }
  ]
}

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

The ID of the newly created vessel.

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>