If your subscription allows, the Web service can return the waypoints that comprise the route between the ports you have selected.

 

Waypoints are returned as an array of Waypoint records.

 

The Web service will always return 'major' waypoints which will consist of any routing points that we passed, any waypoints that the scanner inserts into the route and any waypoint that marks a change from a great circle to a rhumb line or vice versa .

 

The return of additional waypoints is controlled by setting the waypoint spacing required in the RouteFlags.

 

A subscription to the web service can have different minimum waypoint spacings, currently the minimum spacing is 1 mile and the maximum spacing is 512 nm. Depending on the type of your subscription you will either have waypoint spacing of 1 nm or greater or 50 nm or greater. Passing a value that is less than your permitted spacing will not succeed, the waypoint spacing used will be the minimum your subscription permits.

 

Waypoints whose distance to the previous waypoint is less than the minimum allowed will not be returned, neither will the waypoints that comprise a great circle between two waypoints.