RoutesAPI

Method	HTTP request
getCoverageLonLatRoutes	GET /coverage/{lon};{lat}/routes
getCoverageLonLatRoutesId	GET /coverage/{lon};{lat}/routes/{id}
getCoverageLonLatUriRoutes	GET /coverage/{lon};{lat}/{uri}/routes
getCoverageLonLatUriRoutesId	GET /coverage/{lon};{lat}/{uri}/routes/{id}
getCoverageRegionRoutes	GET /coverage/{region}/routes
getCoverageRegionRoutesId	GET /coverage/{region}/routes/{id}
getCoverageRegionUriRoutes	GET /coverage/{region}/{uri}/routes
getCoverageRegionUriRoutesId	GET /coverage/{region}/{uri}/routes/{id}
getRoutes	GET /routes

getCoverageLonLatRoutes

Parameters

Name	Type	Note
lat	Double	The latitude of where the coord you want to query
lon	Double	The longitude of where the coord you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
filter	String	The filter parameter [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageLonLatRoutes(
    lat: 3.4, 
    lon: 3.4, 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatRoutesId

Parameters

Name	Type	Note
lat	Double	The latitude of where the coord you want to query
lon	Double	The longitude of where the coord you want to query
id	String	Id of the object you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageLonLatRoutesId(
    lat: 3.4, 
    lon: 3.4, 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatUriRoutes

Parameters

Name	Type	Note
lat	Double	The latitude of where the coord you want to query
lon	Double	The longitude of where the coord you want to query
uri	String	First part of the uri
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
filter	String	The filter parameter [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageLonLatUriRoutes(
    lat: 3.4, 
    lon: 3.4, 
    uri: "uri_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageLonLatUriRoutesId

Parameters

Name	Type	Note
lat	Double	The latitude of where the coord you want to query
lon	Double	The longitude of where the coord you want to query
uri	String	First part of the uri
id	String	Id of the object you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageLonLatUriRoutesId(
    lat: 3.4, 
    lon: 3.4, 
    uri: "uri_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionRoutes

Parameters

Name	Type	Note
region	String	The region you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
filter	String	The filter parameter [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageRegionRoutes(
    region: "region_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionRoutesId

Parameters

Name	Type	Note
region	String	The region you want to query
id	String	Id of the object you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageRegionRoutesId(
    region: "region_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionUriRoutes

Parameters

Name	Type	Note
region	String	The region you want to query
uri	String	First part of the uri
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
filter	String	The filter parameter [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageRegionUriRoutes(
    region: "region_example", 
    uri: "uri_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionUriRoutesId

Parameters

Name	Type	Note
region	String	The region you want to query
uri	String	First part of the uri
id	String	Id of the object you want to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
externalCode	String	An external code to query [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getCoverageRegionUriRoutesId(
    region: "region_example", 
    uri: "uri_example", 
    id: "id_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    externalCode: "externalCode_example", 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getRoutes

Parameters

Name	Type	Note
externalCode	String	An external code to query
startPage	Int	The page where you want to start [optional]
count	Int	Number of objects you want on a page [optional] [default to 25]
depth	Int	The depth of your object [optional] [default to 1]
forbiddenId	[String]	DEPRECATED, replaced by `forbidden_uris[]` [optional]
forbiddenUris	[String]	forbidden uris [optional]
headsign	String	filter vehicle journeys on headsign [optional]
odtLevel	String	odt level [optional] [default to all] [enum: scheduled, all, zonal, with_stops]
dataFreshness	String	Define the freshness of data to use to filter vehicle_journeys along with parameters &since and/or &until . Provides only the vehicle_journeys valid for the data freshness level requested. Using `&data_freshness=base_schedule` will return all original vehicle_journeys onlywhereas using `&data_freshness=realtime` will return vehicle_journeys after applyingmodifications by realtime (amended vehicle_journeys, and non-impacted original vehicle_journeys). [optional] [default to base_schedule] [enum: base_schedule, adapted_schedule, realtime]
distance	Int	Distance range of the query. Used only if a coord is in the query [optional] [default to 200]
since	Date	filters objects not valid before this date [optional]
until	Date	filters objects not valid after this date [optional]
disableGeojson	Bool	remove geojson from the response [optional]
disableDisruption	Bool	remove disruptions from the response [optional]
filter	String	The filter parameter [optional]
tags	[String]	If filled, will restrain the search within the given disruption tags [optional]
originalId	String	original uri of the object you want to query [optional]

Return

Routes

Example

Expert.shared.routesApi.getRoutes(
    externalCode: "externalCode_example", 
    startPage: 56, 
    count: 25, 
    depth: 1, 
    forbiddenId: ["forbiddenId_example"], 
    forbiddenUris: ["forbiddenUris_example"], 
    headsign: "headsign_example", 
    odtLevel: "all", 
    dataFreshness: "base_schedule", 
    distance: 200, 
    since: Date(), 
    until: Date(), 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example", 
    tags: ["tags_example"], 
    originalId: "originalId_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }