Skip to content

PhysicalModesApi

Method HTTP request
getCoverageLonLatPhysicalModes GET coverage/{lon};{lat}/physical_modes
getCoverageLonLatPhysicalModesId GET coverage/{lon};{lat}/physical_modes/{id}
getCoverageLonLatUriPhysicalModes GET coverage/{lon};{lat}/{uri}/physical_modes
getCoverageLonLatUriPhysicalModesId GET coverage/{lon};{lat}/{uri}/physical_modes/{id}
getCoverageRegionPhysicalModes GET coverage/{region}/physical_modes
getCoverageRegionPhysicalModesId GET coverage/{region}/physical_modes/{id}
getCoverageRegionUriPhysicalModes GET coverage/{region}/{uri}/physical_modes
getCoverageRegionUriPhysicalModesId GET coverage/{region}/{uri}/physical_modes/{id}

getCoverageLonLatPhysicalModes

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageLonLatPhysicalModes(
    lat = 0.0,
    lon = 0.0,
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    filter = "filter_example",
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageLonLatPhysicalModesId

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageLonLatPhysicalModesId(
    lat = 0.0,
    lon = 0.0,
    id = "id_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageLonLatUriPhysicalModes

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageLonLatUriPhysicalModes(
    lat = 0.0,
    lon = 0.0,
    uri = "uri_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    filter = "filter_example",
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageLonLatUriPhysicalModesId

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageLonLatUriPhysicalModesId(
    lat = 0.0,
    lon = 0.0,
    uri = "uri_example",
    id = "id_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageRegionPhysicalModes

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageRegionPhysicalModes(
    region = "region_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    filter = "filter_example",
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageRegionPhysicalModesId

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageRegionPhysicalModesId(
    region = "region_example",
    id = "id_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageRegionUriPhysicalModes

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
filter String The filter parameter [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageRegionUriPhysicalModes(
    region = "region_example",
    uri = "uri_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    filter = "filter_example",
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
} 

getCoverageRegionUriPhysicalModesId

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 List DEPRECATED, replaced by forbidden_uris[] [optional]
forbiddenUris List 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 DateTime filters objects not valid before this date [optional]
until DateTime filters objects not valid after this date [optional]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]
tags List If filled, will restrain the search within the given disruption tags [optional]

Return

PhysicalModes

Example

ExpertSdk.getInstance().physicalModesApi.getCoverageRegionUriPhysicalModesId(
    region = "region_example",
    uri = "uri_example",
    id = "id_example",
    startPage = 123,
    count = 123,
    depth = 123,
    forbiddenId = listOf(),
    forbiddenUris = listOf(),
    externalCode = "externalCode_example",
    headsign = "headsign_example",
    odtLevel = "odtLevel_example",
    dataFreshness = "dataFreshness_example",
    distance = 123,
    since = DateTime.now(),
    until = DateTime.now(),
    disableGeojson = true,
    disableDisruption = true,
    tags = listOf()
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}