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
NameDescriptionTypeAdditional information
VesselStartDateTime

date

None.

VesselStartLocation

PathFinderLocation

Required

VesselEndLocation

PathFinderLocation

Required

VesselSpeed

Speed

None.

AllowSuezCanal

boolean

None.

AllowPanamaCanal

boolean

None.

AllowBeringStrait

boolean

None.

AllowRivers

boolean

None.

UseAutoGenerateEdges

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "VesselStartDateTime": "2022-11-30T07:05:04.6593115+00:00",
  "VesselStartLocation": {
    "Coordinates": null,
    "PortGuid": "6c3f6a79-a65e-4030-b41b-e880fac55316",
    "PortLocode": "sample string 1",
    "PortWPINumber": "sample string 2"
  },
  "VesselEndLocation": {
    "Coordinates": null,
    "PortGuid": "6c3f6a79-a65e-4030-b41b-e880fac55316",
    "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,
  "UseAutoGenerateEdges": true
}

Response Information

Resource Description

The date / time of arrival for the vessel.

PathFinderSummary
NameDescriptionTypeAdditional information
Parameters

PathFinder_Parameters

None.

ETA

date

None.

OverallDistance

Distance

None.

Response Formats

application/json, text/json

Sample:
{
  "Parameters": {
    "VesselStartDateTime": "2022-11-30T07:05:04.6693077+00:00",
    "VesselStartLocation": {
      "Coordinates": null,
      "PortGuid": "51038769-ab7e-4a34-aaf2-168254c2b151",
      "PortLocode": "sample string 1",
      "PortWPINumber": "sample string 2"
    },
    "VesselEndLocation": {
      "Coordinates": null,
      "PortGuid": "51038769-ab7e-4a34-aaf2-168254c2b151",
      "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,
    "UseAutoGenerateEdges": true
  },
  "ETA": "2022-11-30T07:05:04.6693077+00:00",
  "OverallDistance": {
    "Kilometers": 6.5983104,
    "Metres": 6598.3103999999994,
    "NauticalMiles": 3.5628025917926647,
    "StatuteMiles": 4.1
  }
}