MobilityGetTransitRoutePreviewOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
agency | Specifies whether to prefer routes from a specific set of agencies if possible; as a comma separated list. If valid trip isn’t found with the preferred agency, or only one with very long trips or with large number of transfers, itineraries with other agencies will be returned. |
agency |
Specifies the agency identifier to request routes from preferred agencies. By default the agencyType=agencyId. Possible values include: 'agencyId', 'agencyKey', 'agencyName' |
bike |
Bike type of the bike. Specifies which type of bikes will be used. If not specified, all will be allowed. Possible values include: 'privateBike', 'dockedBike' |
destination |
The type of the destination. Possible values include: 'position', 'stopId', 'stopKey' |
language | Language in which search results will be returned. Only NGT is supported. Please refer to Supported languages for details. |
mode |
The mode of travel for the requested route; as comma separated list. If not specified, all modes will be allowed. All modes might not be available in all metro areas. If valid trip is not found, empty result will be returned. |
origin |
The type of the origin. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g., "47.641268,-122.125679”. Possible values include: 'position', 'stopId', 'stopKey' |
route |
The type of route requested. If not specified, 'optimal' will be used. Possible values include: 'optimal', 'leastWalk', 'leastTransfers' |
time | The time of departure or arrival in the local time in ISO format (2019-04-05T14:24:18-04:00). If timeType is not specified, it will be assumed to be 'departure' and time is the current local time at the origin point. |
time |
Specifies whether the time signifies departure time or arrival time. If not defined, default value is 'departure'. Possible values include: 'arrival', 'departure', 'last' |
transit |
Applicable only with modeType = publicTransit. Allow only a specific set of public transit types (as a comma separated list) to be returned for the route. Note that the requested transitType may not be available for the entire route. If not specified, all modes will be allowed. |
Inherited Properties
abort |
The signal which can be used to abort requests. |
custom |
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent. |
on |
Callback which fires upon download progress. |
on |
Callback which fires upon upload progress. |
timeout | The number of milliseconds a request can take before automatically being terminated. |
Property Details
agency
Specifies whether to prefer routes from a specific set of agencies if possible; as a comma separated list. If valid trip isn’t found with the preferred agency, or only one with very long trips or with large number of transfers, itineraries with other agencies will be returned.
agency?: string[]
Property Value
string[]
agencyType
Specifies the agency identifier to request routes from preferred agencies. By default the agencyType=agencyId. Possible values include: 'agencyId', 'agencyKey', 'agencyName'
agencyType?: AgencyType
Property Value
bikeType
Bike type of the bike. Specifies which type of bikes will be used. If not specified, all will be allowed. Possible values include: 'privateBike', 'dockedBike'
bikeType?: BikeType
Property Value
destinationType
The type of the destination. Possible values include: 'position', 'stopId', 'stopKey'
destinationType?: DestinationType
Property Value
language
Language in which search results will be returned. Only NGT is supported. Please refer to Supported languages for details.
language?: string
Property Value
string
modeType
The mode of travel for the requested route; as comma separated list. If not specified, all modes will be allowed. All modes might not be available in all metro areas. If valid trip is not found, empty result will be returned.
modeType?: ModeType[]
Property Value
ModeType[]
originType
The type of the origin. By default originType=position, specified as a comma separated string composed by latitude followed by longitude, e.g., "47.641268,-122.125679”. Possible values include: 'position', 'stopId', 'stopKey'
originType?: OriginType
Property Value
routeType
The type of route requested. If not specified, 'optimal' will be used. Possible values include: 'optimal', 'leastWalk', 'leastTransfers'
routeType?: TransitRouteType
Property Value
time
The time of departure or arrival in the local time in ISO format (2019-04-05T14:24:18-04:00). If timeType is not specified, it will be assumed to be 'departure' and time is the current local time at the origin point.
time?: string
Property Value
string
timeType
Specifies whether the time signifies departure time or arrival time. If not defined, default value is 'departure'. Possible values include: 'arrival', 'departure', 'last'
timeType?: TimeType
Property Value
transitType
Applicable only with modeType = publicTransit. Allow only a specific set of public transit types (as a comma separated list) to be returned for the route. Note that the requested transitType may not be available for the entire route. If not specified, all modes will be allowed.
transitType?: TransitTypeFilter[]
Property Value
Inherited Property Details
abortSignal
The signal which can be used to abort requests.
abortSignal?: AbortSignalLike
Property Value
AbortSignalLike
Inherited From RequestOptionsBase.abortSignal
customHeaders
{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
customHeaders?: [key: string]: string
Property Value
[key: string]: string
Inherited From RequestOptionsBase.customHeaders
onDownloadProgress
Callback which fires upon download progress.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onDownloadProgress
onUploadProgress
Callback which fires upon upload progress.
onUploadProgress?: (progress: TransferProgressEvent) => void
Property Value
(progress: TransferProgressEvent) => void
Inherited From RequestOptionsBase.onUploadProgress
timeout
The number of milliseconds a request can take before automatically being terminated.
timeout?: number
Property Value
number
Inherited From RequestOptionsBase.timeout