POST api/PathFinderSummary

Takes a vessel's starting location, departime date / time, speed, and end location and returns the summary details for the route.

Request Information

URI Parameters

None.

Body Parameters

The parameters for the route

PathFinder_Parameters

Name	Description	Type	Additional information
VesselStartDateTime	The date / time of the start of the journey. Defaults to UTC NOW if not provided. Time zone / daylight saving is ignored. For example: if a UTC value is passed, all returned values will also be UTC	date	None.
VesselStartLocation	The vessel's start location	PathFinderLocation	Required
VesselEndLocation	The vessel's end location	PathFinderLocation	Required
VesselSpeed	The speed of the vessel. Defaults to 10 knots if not provided.	Speed	None.
AllowSuezCanal	Defines whether the vessel is allowed to use the Suez Canal in this route. Defaults to true if not provided.	boolean	None.
AllowPanamaCanal	Defines whether the vessel is allowed to use the Panama Canal in this route. Defaults to true if not provided.	boolean	None.
AllowBeringStrait	Defines whether the vessel is allowed to use the Bering Strait in this route. Defaults to false if not provided.	boolean	None.
AllowRivers	Defines whether the vessel is allowed to use rivers in this route. Defaults to false if not provided.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "VesselStartDateTime": "2020-09-26T20:39:14.9753982+00:00",
  "VesselStartLocation": {
    "Coordinates": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "PortGuid": "89340775-709c-48d9-b831-2a95c45882eb",
    "PortLocode": "sample string 1",
    "PortWPINumber": "sample string 2"
  },
  "VesselEndLocation": {
    "Coordinates": {
      "Lat": 1.1,
      "Lon": 2.1
    },
    "PortGuid": "89340775-709c-48d9-b831-2a95c45882eb",
    "PortLocode": "sample string 1",
    "PortWPINumber": "sample string 2"
  },
  "VesselSpeed": {
    "Knots": 7.9697624190064591,
    "Kph": 14.76,
    "Mph": 9.171438797423038,
    "Ms": 4.1
  },
  "AllowSuezCanal": true,
  "AllowPanamaCanal": true,
  "AllowBeringStrait": true,
  "AllowRivers": true
}

application/xml, text/xml

Sample:

<PathFinder_Parameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselStartDateTime>2020-09-26T20:39:14.9753982+00:00</VesselStartDateTime>
  <VesselStartLocation>
    <Coordinates>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Coordinates>
    <PortGuid>89340775-709c-48d9-b831-2a95c45882eb</PortGuid>
    <PortLocode>sample string 1</PortLocode>
    <PortWPINumber>sample string 2</PortWPINumber>
  </VesselStartLocation>
  <VesselEndLocation>
    <Coordinates>
      <Lat>1.1</Lat>
      <Lon>2.1</Lon>
    </Coordinates>
    <PortGuid>89340775-709c-48d9-b831-2a95c45882eb</PortGuid>
    <PortLocode>sample string 1</PortLocode>
    <PortWPINumber>sample string 2</PortWPINumber>
  </VesselEndLocation>
  <VesselSpeed>
    <Knots>7.9697624190064591</Knots>
    <Kph>14.76</Kph>
    <Mph>9.171438797423038</Mph>
    <Ms>4.1</Ms>
  </VesselSpeed>
  <AllowSuezCanal>true</AllowSuezCanal>
  <AllowPanamaCanal>true</AllowPanamaCanal>
  <AllowBeringStrait>true</AllowBeringStrait>
  <AllowRivers>true</AllowRivers>
</PathFinder_Parameters>

Response Information

Resource Description

The date / time of arrival for the vessel.

PathFinderSummary

Name	Description	Type	Additional information
Parameters	The parameters for the route	PathFinder_Parameters	None.
ETA	The ETA of the vessel	date	None.
OverallDistance	The overall distance that the vessel will travel	Distance	None.

Response Formats

application/json, text/json

Sample:

{
  "Parameters": {
    "VesselStartDateTime": "2020-09-26T20:39:14.9753982+00:00",
    "VesselStartLocation": {
      "Coordinates": {
        "Lat": 1.1,
        "Lon": 2.1
      },
      "PortGuid": "94cb94f6-ef21-48f8-8f54-a096d2aac61b",
      "PortLocode": "sample string 1",
      "PortWPINumber": "sample string 2"
    },
    "VesselEndLocation": {
      "Coordinates": {
        "Lat": 1.1,
        "Lon": 2.1
      },
      "PortGuid": "94cb94f6-ef21-48f8-8f54-a096d2aac61b",
      "PortLocode": "sample string 1",
      "PortWPINumber": "sample string 2"
    },
    "VesselSpeed": {
      "Knots": 7.9697624190064591,
      "Kph": 14.76,
      "Mph": 9.171438797423038,
      "Ms": 4.1
    },
    "AllowSuezCanal": true,
    "AllowPanamaCanal": true,
    "AllowBeringStrait": true,
    "AllowRivers": true
  },
  "ETA": "2020-09-26T20:39:14.9753982+00:00",
  "OverallDistance": {
    "Kilometers": 6.5983104,
    "Metres": 6598.3103999999994,
    "NauticalMiles": 3.5628025917926647,
    "StatuteMiles": 4.1
  }
}

application/xml, text/xml

Sample:

<PathFinderSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Parameters>
    <VesselStartDateTime>2020-09-26T20:39:14.9753982+00:00</VesselStartDateTime>
    <VesselStartLocation>
      <Coordinates>
        <Lat>1.1</Lat>
        <Lon>2.1</Lon>
      </Coordinates>
      <PortGuid>94cb94f6-ef21-48f8-8f54-a096d2aac61b</PortGuid>
      <PortLocode>sample string 1</PortLocode>
      <PortWPINumber>sample string 2</PortWPINumber>
    </VesselStartLocation>
    <VesselEndLocation>
      <Coordinates>
        <Lat>1.1</Lat>
        <Lon>2.1</Lon>
      </Coordinates>
      <PortGuid>94cb94f6-ef21-48f8-8f54-a096d2aac61b</PortGuid>
      <PortLocode>sample string 1</PortLocode>
      <PortWPINumber>sample string 2</PortWPINumber>
    </VesselEndLocation>
    <VesselSpeed>
      <Knots>7.9697624190064591</Knots>
      <Kph>14.76</Kph>
      <Mph>9.171438797423038</Mph>
      <Ms>4.1</Ms>
    </VesselSpeed>
    <AllowSuezCanal>true</AllowSuezCanal>
    <AllowPanamaCanal>true</AllowPanamaCanal>
    <AllowBeringStrait>true</AllowBeringStrait>
    <AllowRivers>true</AllowRivers>
  </Parameters>
  <ETA>2020-09-26T20:39:14.9753982+00:00</ETA>
  <OverallDistance>
    <Kilometers>6.5983104</Kilometers>
    <Metres>6598.3103999999994</Metres>
    <NauticalMiles>3.5628025917926647</NauticalMiles>
    <StatuteMiles>4.1</StatuteMiles>
  </OverallDistance>
</PathFinderSummary>