Plans a transit journey between two points.
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 |
Origin | Origin coordinates (latitude,longitude) | Text (Short) | Yes | None |
GeomFormat | Geometry format for the response | Text (Short) | No | None |
Destination | Destination coordinates (latitude,longitude) | Text (Short) | Yes | None |
MaxTransfers | Maximum number of transfers allowed | Number | No | None |
WalkingSpeed | Walking speed in m/s | Number | No | None |
DepartureTime | Departure time for the journey | Datetime | Yes | None |
TransportMode | Transport mode code | Number | Yes | None |
WalkingSafety | Walking safety factor | Number | No | None |
NumAlternatives | Number of alternative routes to return | Number | No | None |
WheelchairAccess | Whether wheelchair access is required | True/False | No | None |
IntermediateStops | Whether to include intermediate stops | True/False | No | None |
WaitingReluctance | Waiting reluctance factor | Number | No | None |
WalkingReluctance | Walking reluctance factor | Number | 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. |