GET api/TransferPlans?minStart={minStart}&maxStart={maxStart}
Gets a list of transfer plans for the current project.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| minStart |
Optional. Only transfer plans that start at or after this date and time will be included. |
date |
None. |
| maxStart |
Optional. Only transfer plans that start at or before this date and time will be included. |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of transfer plans.
Collection of TransferPlanReadyToSchedule| 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 TransferPlanOperationReadyToSchedule |
Required |
| TransferPlanVessels |
A list of the vessels assigned to the transfer plan. |
Collection of TransferPlanVesselReadyToSchedule |
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. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"Operations": [
{
"Id": 1,
"TransferPlanId": 1,
"Thresholds": [
{
"Variable": {
"Id": 1,
"Name": "Significant wave height",
"Units": "m",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 1.5,
"IsIgnored": false
},
{
"Variable": {
"Id": 5,
"Name": "Wind speed",
"Units": "m/s",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 17.0,
"IsIgnored": false
}
],
"StageDurations": [
{
"Stage": {
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
},
"Order": 1
},
"DurationMinutes": 120
}
],
"Name": "Load",
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
},
"Asset1": {
"Id": 1,
"Name": "Port",
"Identifier": "Asset 1",
"Latitude": 0.0,
"Longitude": 1.0,
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
}
},
"Asset2": null,
"Type": 1,
"Order": 1,
"HasThresholds": true,
"Description": "",
"WaitsForOperationOrder": null
},
{
"Id": 2,
"TransferPlanId": 1,
"Thresholds": [
{
"Variable": {
"Id": 1,
"Name": "Significant wave height",
"Units": "m",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 2.2,
"IsIgnored": false
},
{
"Variable": {
"Id": 2,
"Name": "Wave period",
"Units": "secs",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 6.0,
"IsIgnored": false
},
{
"Variable": {
"Id": 5,
"Name": "Wind speed",
"Units": "m/s",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 20.0,
"IsIgnored": false
}
],
"StageDurations": [
{
"Stage": {
"ForecastPoint": {
"Id": 2,
"Name": "Forecast point 2",
"Latitude": 1.0,
"Longitude": 0.1
},
"Order": 1
},
"DurationMinutes": 60
}
],
"Name": "Transit to A1",
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
},
"Asset1": {
"Id": 1,
"Name": "Port",
"Identifier": "Asset 1",
"Latitude": 0.0,
"Longitude": 1.0,
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
}
},
"Asset2": {
"Id": 2,
"Name": "A1",
"Identifier": "Asset 2",
"Latitude": 1.0,
"Longitude": 0.0,
"ForecastPoint": {
"Id": 3,
"Name": "Forecast point 3",
"Latitude": 1.1,
"Longitude": 0.0
}
},
"Type": 1,
"Order": 2,
"HasThresholds": true,
"Description": "",
"WaitsForOperationOrder": null
}
],
"TransferPlanVessels": [
{
"TransferPlanId": 1,
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
}
}
],
"Name": "The name of this transfer plan",
"Description": "An optional description for this transfer plan.",
"StartDate": "2017-06-16T22:00:00"
},
{
"Id": 2,
"Operations": [
{
"Id": 3,
"TransferPlanId": 2,
"Thresholds": [
{
"Variable": {
"Id": 1,
"Name": "Significant wave height",
"Units": "m",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 2.5,
"IsIgnored": false
},
{
"Variable": {
"Id": 5,
"Name": "Wind speed",
"Units": "m/s",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 17.0,
"IsIgnored": false
}
],
"StageDurations": [
{
"Stage": {
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
},
"Order": 1
},
"DurationMinutes": 120
}
],
"Name": "Maintenance",
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
},
"Asset1": {
"Id": 1,
"Name": "Port",
"Identifier": "Asset 1",
"Latitude": 0.0,
"Longitude": 1.0,
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
}
},
"Asset2": null,
"Type": 1,
"Order": 1,
"HasThresholds": true,
"Description": "",
"WaitsForOperationOrder": null
},
{
"Id": 4,
"TransferPlanId": 2,
"Thresholds": [
{
"Variable": {
"Id": 1,
"Name": "Significant wave height",
"Units": "m",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 2.2,
"IsIgnored": false
},
{
"Variable": {
"Id": 2,
"Name": "Wave period",
"Units": "secs",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 6.0,
"IsIgnored": false
},
{
"Variable": {
"Id": 5,
"Name": "Wind speed",
"Units": "m/s",
"IsDirection": false,
"IsBelowThresholdSuccess": true
},
"MinThresholdValue": null,
"MaxThresholdValue": 20.0,
"IsIgnored": false
}
],
"StageDurations": [
{
"Stage": {
"ForecastPoint": {
"Id": 2,
"Name": "Forecast point 2",
"Latitude": 1.0,
"Longitude": 0.1
},
"Order": 1
},
"DurationMinutes": 60
},
{
"Stage": {
"ForecastPoint": {
"Id": 3,
"Name": "Forecast point 3",
"Latitude": 1.1,
"Longitude": 0.0
},
"Order": 2
},
"DurationMinutes": 30
}
],
"Name": "Transit to A3",
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
},
"Asset1": {
"Id": 1,
"Name": "Port",
"Identifier": "Asset 1",
"Latitude": 0.0,
"Longitude": 1.0,
"ForecastPoint": {
"Id": 10,
"Name": "Forecast point 10",
"Latitude": 0.0,
"Longitude": 1.0
}
},
"Asset2": {
"Id": 4,
"Name": "A3",
"Identifier": "Asset 4",
"Latitude": 1.0,
"Longitude": 2.0,
"ForecastPoint": {
"Id": 11,
"Name": "Forecast point 11",
"Latitude": 1.0,
"Longitude": 2.0
}
},
"Type": 1,
"Order": 2,
"HasThresholds": true,
"Description": "",
"WaitsForOperationOrder": null
}
],
"TransferPlanVessels": [
{
"TransferPlanId": 1,
"Vessel": {
"Id": 1,
"Name": "Vessel 1",
"Identifier": "Vessel 1",
"OperationalThresholdsGroups": null
}
}
],
"Name": "The name of this transfer plan",
"Description": "A description for this transfer plan.",
"StartDate": "2017-06-26T22:00:00"
}
]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.