Skip to main content

Create onboarding GTS calculate route in Ahoy Movement Studio

Wrk Product avatar
Written by Wrk Product
Updated over 5 months ago

Calculates a route between two or more points, considering various parameters.

Application

  • Ahoy Movement Studio

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Text (Short)

Yes

None

Avoid

List of things to avoid in the route

Text (Long)

No

None

Route type

Type of route to calculate

Text (Short)

Yes

None

Query points

List of points for the route

Text (Long)

Yes

None

Alternatives

Number of alternative routes to calculate

Number

No

None

VehicleWidth

Width of the vehicle

Number

No

None

VehicleHeight

Height of the vehicle

Number

No

None

VehicleWeight

Weight of the vehicle

Number

No

None

Mode of transport

List of transport modes

Text (Long)

Yes

None

AllowExtendedSegmentGeoms

Whether to allow extended segment geometries

True/False

No

None

Outputs (what you get)

Name

Description

Data Type

Required?

Example

Response body

The main content of the response

Text (Long)

No

None

Response status code

The HTTP status code returned in the response

Number

No

None

Response headers

Additional information provided in the response headers

Text (Long)

No

None

Outcomes

Name

Description

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Success

This status is selected if the job has successfully completed.

Did this answer your question?