MobilityGetRealTimeArrivalsPreviewOptionalParams interface
Optional Parameters.
- Extends
-
RequestOptionsBase
Properties
agency | In case you prefer routes from a specific set of agencies to be returned. Specified as a comma separated string. |
agency |
Specifies the agency identifier to request routes from a specific set of agencies to be returned. By default the agencyType=agencyId. Possible values include: 'agencyId', 'agencyKey', 'agencyName' |
language | Language in which search results will be returned. Only NGT is supported. Please refer to Supported languages for details. |
limit | The maximum arrivals to return. If not specified, the system default will be used. For stops max number of arrivals per stop. For lines max arrivals per stop on the line. For everything else max arrivals overall. |
max |
The maximum time (in minutes) in the future to return arrivals for. If not specified, the system default (30 minutes) will be used. The minimum value is 0 and maximum value is 60 minutes. |
query |
The type of the query parameter. Defines the mode of the request. Only one mode per request is supported. By default queryType is set to be ‘stops’ returning the requested number of Live Arrivals for all lines arriving at the specified stop. Possible values include: 'stops', 'line', 'lineAndStop', 'position' |
stop |
The type of the unique query parameter of the stop. By default stopQueryType=stopId. This parameter can only be used in conjunction with queryType=stops or queryType=lineAndStop. Possible values include: 'stopId', 'stopKey' |
timeout |
Time in seconds within which if the provider doesn’t respond, end point will return static data. |
transit |
Type of public transit user is requesting respective transit stop, as a comma separated list. If not specified, all will be allowed. This parameter can only be used in conjunction with queryType=stops. Supported transit types are Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular. For example, transitType=Bus,Subway. |
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
In case you prefer routes from a specific set of agencies to be returned. Specified as a comma separated string.
agency?: string[]
Property Value
string[]
agencyType
Specifies the agency identifier to request routes from a specific set of agencies to be returned. By default the agencyType=agencyId. Possible values include: 'agencyId', 'agencyKey', 'agencyName'
agencyType?: AgencyType
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
limit
The maximum arrivals to return. If not specified, the system default will be used. For stops max number of arrivals per stop. For lines max arrivals per stop on the line. For everything else max arrivals overall.
limit?: number
Property Value
number
maxMinutesInFuture
The maximum time (in minutes) in the future to return arrivals for. If not specified, the system default (30 minutes) will be used. The minimum value is 0 and maximum value is 60 minutes.
maxMinutesInFuture?: number
Property Value
number
queryType
The type of the query parameter. Defines the mode of the request. Only one mode per request is supported. By default queryType is set to be ‘stops’ returning the requested number of Live Arrivals for all lines arriving at the specified stop. Possible values include: 'stops', 'line', 'lineAndStop', 'position'
queryType?: RealTimeArrivalsQueryType
Property Value
stopQueryType
The type of the unique query parameter of the stop. By default stopQueryType=stopId. This parameter can only be used in conjunction with queryType=stops or queryType=lineAndStop. Possible values include: 'stopId', 'stopKey'
stopQueryType?: StopQueryType
Property Value
timeoutInSeconds
Time in seconds within which if the provider doesn’t respond, end point will return static data.
timeoutInSeconds?: number
Property Value
number
transitType
Type of public transit user is requesting respective transit stop, as a comma separated list. If not specified, all will be allowed. This parameter can only be used in conjunction with queryType=stops. Supported transit types are Tram, Subway, Rail, Bus, Ferry, CableCar, Gondola, Funicular. For example, transitType=Bus,Subway.
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