POST api/TransferPlans/Update?updateDetailsOnly={updateDetailsOnly}

Updates a transfer plan.

Request Information

URI Parameters

Name	Description	Type	Additional information
updateDetailsOnly	If true, only transfer plan details (name, description, start date) will be updated and any additional vessels added. Any saved schedules will remain. If false, all elements of the transfer plan will be updated and any schedules that have been saved prior to the update will be lost.	boolean	Required

Body Parameters

The transfer plan to update.

TransferPlanChanged

Name	Description	Type	Additional information
Id	The ID of the transfer plan.	integer	Required
Operations	A list of the operations each vessel is required to perform.	Collection of TransferPlanOperationChanged	Required
TransferPlanVessels	A list of the vessels assigned to the transfer plan.	Collection of TransferPlanVesselChanged	Required
Name	The name of the transfer plan.	string	Required String length: inclusive between 0 and 100
Description	A description of the transfer plan.	string	None.
StartDate	The preferred start date and time for the transfer plan.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Operations": [
    {
      "Id": 2,
      "TransferPlanId": 1,
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 1.7,
          "IsIgnored": false
        },
        {
          "Variable": {
            "Id": 2
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 2.0,
          "IsIgnored": false
        }
      ],
      "Vessel": {
        "Id": 1
      },
      "Asset1": {
        "Id": 1
      },
      "Asset2": {
        "Id": 2
      },
      "StageDurations": null,
      "Name": "A new name for this operation",
      "Type": 1,
      "Order": 1,
      "HasThresholds": true,
      "Description": "A new description for this operation",
      "WaitsForOperationOrder": null
    },
    {
      "Id": 0,
      "TransferPlanId": 1,
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 1.5,
          "IsIgnored": false
        }
      ],
      "Vessel": {
        "Id": 1
      },
      "Asset1": {
        "Id": 2
      },
      "Asset2": null,
      "StageDurations": [
        {
          "Stage": {
            "ForecastPoint": {
              "Id": 10
            },
            "Order": 1
          },
          "DurationMinutes": 30
        }
      ],
      "Name": "A new operation",
      "Type": 1,
      "Order": 2,
      "HasThresholds": true,
      "Description": "An optional description for this new operation",
      "WaitsForOperationOrder": null
    }
  ],
  "TransferPlanVessels": [
    {
      "TransferPlanId": 1,
      "Vessel": {
        "Id": 1
      }
    }
  ],
  "Name": "The name of this transfer plan",
  "Description": "An optional description for this transfer plan.",
  "StartDate": "2017-04-26T09:00:00"
}

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.