GET api/TransitStageDurations/Templates?startAssetId={startAssetId}&endAssetId={endAssetId}&order={order}

Gets the transit stage duration template with the given order between two assets.

Request Information

URI Parameters

Name	Description	Type	Additional information
startAssetId	The ID of the asset which defines the starting point of the transit.	integer	Required
endAssetId	The ID of the asset which defines the end point of the transit.	integer	Required
order	The order of the stage within the transit.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The requested transit stage duration template.

TransitStageDurationTemplateReadyToSchedule

Name	Description	Type	Additional information
Asset1	The asset which defines the starting point of the transit.	Asset	Required
Asset2	The asset which defines the end point of the transit.	Asset	Required
ForecastPoint	The metocean data location associated with this stage.	ForecastPoint	Required
Order	The order of the stage within the transit.	integer	Required Range: inclusive between 1 and 2147483647
DurationMinutes	The duration of this stage of the transit, in minutes.	integer	Required Range: inclusive between 1 and 2147483647

Response Formats

application/json, text/json

Sample:

{
  "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
    }
  },
  "ForecastPoint": {
    "Id": 2,
    "Name": "Forecast point 2",
    "Latitude": 1.0,
    "Longitude": 0.1
  },
  "Order": 1,
  "DurationMinutes": 60
}

application/xml, text/xml

Sample:

<TransitStageDurationTemplateReadyToSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.OAndM">
  <Asset1>
    <ForecastPoint xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:HotSpotCoordinates i:nil="true" />
      <d3p1:HotSpotType i:nil="true" />
      <d3p1:Id>10</d3p1:Id>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>1</d3p1:Longitude>
      <d3p1:Name>Forecast point 10</d3p1:Name>
    </ForecastPoint>
    <Id>1</Id>
    <Identifier>Asset 1</Identifier>
    <Latitude>0</Latitude>
    <Longitude>1</Longitude>
    <Name>Port</Name>
    <ProjectId>0</ProjectId>
  </Asset1>
  <Asset2>
    <ForecastPoint xmlns:d3p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
      <d3p1:HotSpotCoordinates i:nil="true" />
      <d3p1:HotSpotType i:nil="true" />
      <d3p1:Id>11</d3p1:Id>
      <d3p1:Latitude>1</d3p1:Latitude>
      <d3p1:Longitude>2</d3p1:Longitude>
      <d3p1:Name>Forecast point 11</d3p1:Name>
    </ForecastPoint>
    <Id>4</Id>
    <Identifier>Asset 4</Identifier>
    <Latitude>1</Latitude>
    <Longitude>2</Longitude>
    <Name>A3</Name>
    <ProjectId>0</ProjectId>
  </Asset2>
  <DurationMinutes>60</DurationMinutes>
  <ForecastPoint xmlns:d2p1="http://schemas.datacontract.org/2004/07/ForeCoastMarine.Core.Models">
    <d2p1:HotSpotCoordinates i:nil="true" />
    <d2p1:HotSpotType i:nil="true" />
    <d2p1:Id>2</d2p1:Id>
    <d2p1:Latitude>1</d2p1:Latitude>
    <d2p1:Longitude>0.1</d2p1:Longitude>
    <d2p1:Name>Forecast point 2</d2p1:Name>
  </ForecastPoint>
  <Order>1</Order>
</TransitStageDurationTemplateReadyToSchedule>