GET api/v{version}/Vessels/GenerateWeatherWindows?vesselId={vesselId}&assetId={assetId}&date={date}

Generates the weather windows for the given vessel at the given asset on the given day. Weather windows are based on deterministic data only.

Request Information

URI Parameters

Name	Description	Type	Additional information
vesselId	The ID of the vessel.	integer	Required
assetId	The ID of the asset.	integer	Required
date	The day for which weather windows should be generated. Any time component will be ignored.	date	Required
version		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of IWeatherWindow

Name	Description	Type	Additional information
Start	The start of the weather window.	date	None.
Finish	The end of the weather window.	date	None.
TimeStepViabilities	The viability value at each time step in the weather window.	Collection of TimeStepViability	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Start": "2017-12-07T01:00:00",
    "Finish": "2017-12-07T03:00:00",
    "TimeStepViabilities": [
      {
        "TimeStep": "2017-12-07T01:00:00",
        "Viability": 0.5
      },
      {
        "TimeStep": "2017-12-07T02:00:00",
        "Viability": 0.5
      },
      {
        "TimeStep": "2017-12-07T03:00:00",
        "Viability": 0.05
      }
    ]
  },
  {
    "Start": "2017-12-07T15:00:00",
    "Finish": "2017-12-07T16:00:00",
    "TimeStepViabilities": [
      {
        "TimeStep": "2017-12-07T15:00:00",
        "Viability": 0.95
      },
      {
        "TimeStep": "2017-12-07T16:00:00",
        "Viability": 0.05
      }
    ]
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.