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	Type	Additional information
Schema	Pathfinder_Schema	None.
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:

{
  "Schema": 0,
  "VesselStartDateTime": "2022-05-16T22:22:20.706074+00:00",
  "VesselStartLocation": {
    "Coordinates": null,
    "PortGuid": "502e7e2c-9889-483f-9bdb-7e0e27399492",
    "PortLocode": "sample string 1",
    "PortWPINumber": "sample string 2"
  },
  "VesselEndLocation": {
    "Coordinates": null,
    "PortGuid": "502e7e2c-9889-483f-9bdb-7e0e27399492",
    "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

Name	Type	Additional information
Parameters	PathFinder_Parameters	None.
ETA	date	None.
OverallDistance	Distance	None.

Response Formats

application/json, text/json

Sample:

{
  "Parameters": {
    "Schema": 0,
    "VesselStartDateTime": "2022-05-16T22:22:20.721642+00:00",
    "VesselStartLocation": {
      "Coordinates": null,
      "PortGuid": "3a9ceea0-aa3c-4660-a2b3-f4f2f15c7970",
      "PortLocode": "sample string 1",
      "PortWPINumber": "sample string 2"
    },
    "VesselEndLocation": {
      "Coordinates": null,
      "PortGuid": "3a9ceea0-aa3c-4660-a2b3-f4f2f15c7970",
      "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-05-16T22:22:20.721642+00:00",
  "OverallDistance": {
    "Kilometers": 6.5983104,
    "Metres": 6598.3103999999994,
    "NauticalMiles": 3.5628025917926647,
    "StatuteMiles": 4.1
  }
}