POST api/v{version}/TransferPlans

Creates a transfer plan in the user's current project.

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

The transfer plan to create.

TransferPlanNew

Name	Description	Type	Additional information
Operations	A list of the operations each vessel is required to perform.	Collection of TransferPlanOperationNew	Required
TransferPlanVessels	A list of the vessels assigned to the transfer plan.	Collection of TransferPlanVesselNew	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:

{
  "Operations": [
    {
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 1.7,
          "IsIgnored": false
        },
        {
          "Variable": {
            "Id": 2
          },
          "MinThresholdValue": 1.0,
          "MaxThresholdValue": 2.0,
          "IsIgnored": false
        }
      ],
      "Vessel": {
        "Id": 1
      },
      "Asset1": {
        "Id": 1
      },
      "Asset2": null,
      "StageDurations": [
        {
          "Stage": {
            "ForecastPoint": {
              "Id": 10
            },
            "Order": 1
          },
          "DurationMinutes": 120
        }
      ],
      "Name": "Operation 1",
      "Type": 1,
      "Order": 1,
      "HasThresholds": true,
      "Description": "An optional description of the operation",
      "WaitsForOperationOrder": null
    },
    {
      "Thresholds": [
        {
          "Variable": {
            "Id": 1
          },
          "MinThresholdValue": null,
          "MaxThresholdValue": 1.5,
          "IsIgnored": false
        }
      ],
      "Vessel": {
        "Id": 1
      },
      "Asset1": {
        "Id": 1
      },
      "Asset2": {
        "Id": 2
      },
      "StageDurations": [
        {
          "Stage": {
            "ForecastPoint": {
              "Id": 2
            },
            "Order": 1
          },
          "DurationMinutes": 60
        }
      ],
      "Name": "Operation 2",
      "Type": 1,
      "Order": 2,
      "HasThresholds": true,
      "Description": "An optional description of the operation",
      "WaitsForOperationOrder": null
    }
  ],
  "TransferPlanVessels": [
    {
      "Vessel": {
        "Id": 1
      }
    },
    {
      "Vessel": {
        "Id": 2
      }
    }
  ],
  "Name": "Transfer plan 1",
  "Description": "An optional description of the 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

The ID of the newly created transfer plan.

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

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