POST api/Vessels/Update?thresholdsGroupId={thresholdsGroupId}

Replaces the existing thresholds of a vessel thresholds group with another set of thresholds.

Request Information

URI Parameters

Name	Description	Type	Additional information
thresholdsGroupId	The ID of a vessel thresholds group.	integer	Required

Body Parameters

The thresholds to assign to the thresholds group.

Collection of MetoceanThresholdReference

Name	Description	Type	Additional information
Variable	A reference to a metocean variable.	Reference	Required
MinThresholdValue	The lower bound of the threshold. If the metocean variable is such that the threshold defines a value which must not be exceeded, the lower bound is not specified.	decimal number	None.
MaxThresholdValue	The upper bound of the threshold. If the metocean variable is such that the threshold defines a value which must be exceeded, the upper bound is not specified.	decimal number	None.
IsIgnored	If true, the time series values of the metocean variable do not affect the viability of operations.	boolean	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "Variable": {
      "Id": 1
    },
    "MinThresholdValue": 1.1,
    "MaxThresholdValue": 1.1,
    "IsIgnored": true
  },
  {
    "Variable": {
      "Id": 1
    },
    "MinThresholdValue": 1.1,
    "MaxThresholdValue": 1.1,
    "IsIgnored": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfMetoceanThresholdReference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
  <MetoceanThresholdReference>
    <IsIgnored>true</IsIgnored>
    <MaxThresholdValue>1.1</MaxThresholdValue>
    <MinThresholdValue>1.1</MinThresholdValue>
    <ThresholdDescription>sample string 2</ThresholdDescription>
    <Variable>
      <HeightAdjustmentEnabled>true</HeightAdjustmentEnabled>
      <Id>1</Id>
      <Interval>1</Interval>
      <IsBelowThresholdSuccess>true</IsBelowThresholdSuccess>
      <IsDirection>true</IsDirection>
      <MaxValue>1</MaxValue>
      <MinValue>1</MinValue>
      <Name>sample string 2</Name>
      <ThresholdType>Limit</ThresholdType>
      <Units>sample string 3</Units>
    </Variable>
    <VariableReference xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core">
      <d3p1:Id>1</d3p1:Id>
    </VariableReference>
  </MetoceanThresholdReference>
  <MetoceanThresholdReference>
    <IsIgnored>true</IsIgnored>
    <MaxThresholdValue>1.1</MaxThresholdValue>
    <MinThresholdValue>1.1</MinThresholdValue>
    <ThresholdDescription>sample string 2</ThresholdDescription>
    <Variable>
      <HeightAdjustmentEnabled>true</HeightAdjustmentEnabled>
      <Id>1</Id>
      <Interval>1</Interval>
      <IsBelowThresholdSuccess>true</IsBelowThresholdSuccess>
      <IsDirection>true</IsDirection>
      <MaxValue>1</MaxValue>
      <MinValue>1</MinValue>
      <Name>sample string 2</Name>
      <ThresholdType>Limit</ThresholdType>
      <Units>sample string 3</Units>
    </Variable>
    <VariableReference xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core">
      <d3p1:Id>1</d3p1:Id>
    </VariableReference>
  </MetoceanThresholdReference>
</ArrayOfMetoceanThresholdReference>

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.