GET api/v{version}/TransferPlans/GenerateStartTimes?id={id}&vesselId={vesselId}&maxStart={maxStart}

Generates possible start times for a transfer plan within the current forecast range. Generated start times are 'on the hour'.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of a transfer plan.	integer	Required
vesselId	The ID of a vessel in the transfer plan.	integer	Required
maxStart	Optional. If provided, only start times up to the given date and time will be returned.	date	None.
version		string	None.

Body Parameters

None.

Response Information

Resource Description

Statistics for the transfer plan based on different possible start times.

Collection of ApiScheduleStatistics

Name	Description	Type	Additional information
ScheduleStatistics	The summary statistics for the schedule.	ScheduleStatistics	None.
ScheduleHyperlink	A hyperlink to the ForeCoast® Marine O&M schedule page.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ScheduleStatistics": {
      "StartDate": "2017-04-26T09:00:00",
      "TotalDurationMinutes": 190,
      "TotalDowntimeMinutes": 60
    },
    "ScheduleHyperlink": "https://app.forecoastmarine.com/OAndM/Schedule.aspx?id=1&start=20170426T0900Z"
  },
  {
    "ScheduleStatistics": {
      "StartDate": "2017-04-26T10:00:00",
      "TotalDurationMinutes": 130,
      "TotalDowntimeMinutes": 0
    },
    "ScheduleHyperlink": "https://app.forecoastmarine.com/OAndM/Schedule.aspx?id=1&start=20170426T1000Z"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiScheduleStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForePlanner.Models">
  <ApiScheduleStatistics>
    <ScheduleHyperlink>https://app.forecoastmarine.com/OAndM/Schedule.aspx?id=1&amp;start=20170426T0900Z</ScheduleHyperlink>
    <ScheduleStatistics xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:StartDate>2017-04-26T09:00:00</d3p1:StartDate>
      <d3p1:TotalDowntimeMinutes>60</d3p1:TotalDowntimeMinutes>
      <d3p1:TotalDurationMinutes>190</d3p1:TotalDurationMinutes>
    </ScheduleStatistics>
  </ApiScheduleStatistics>
  <ApiScheduleStatistics>
    <ScheduleHyperlink>https://app.forecoastmarine.com/OAndM/Schedule.aspx?id=1&amp;start=20170426T1000Z</ScheduleHyperlink>
    <ScheduleStatistics xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:StartDate>2017-04-26T10:00:00</d3p1:StartDate>
      <d3p1:TotalDowntimeMinutes>0</d3p1:TotalDowntimeMinutes>
      <d3p1:TotalDurationMinutes>130</d3p1:TotalDurationMinutes>
    </ScheduleStatistics>
  </ApiScheduleStatistics>
</ArrayOfApiScheduleStatistics>