POST api/PathFinderRouteGeoJSON

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

Request Information

URI Parameters

None.

Body Parameters

The parameters for the route

PathFinder_Parameters

Name	Type	Additional 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": "2023-03-31T09:13:31.8132665+00:00",
  "VesselStartLocation": {
    "Coordinates": null,
    "PortGuid": "62a3a577-6ef8-4db7-a6f9-8710eecc24ca",
    "PortLocode": "sample string 1",
    "PortWPINumber": "sample string 2"
  },
  "VesselEndLocation": {
    "Coordinates": null,
    "PortGuid": "62a3a577-6ef8-4db7-a6f9-8710eecc24ca",
    "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 API will return the route in GeoJSON format (see https://geojson.org/).

The unescaped GeoJSON string can be found in the Content of the HttpResponseMessage.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.