Skip to content

PtobjectsAPI

Method HTTP request
getCoverageLonLatPtObjects GET /coverage/{lon};{lat}/pt_objects
getCoverageRegionPtObjects GET /coverage/{region}/pt_objects

getCoverageLonLatPtObjects

Parameters

Name Type Note
q String The data to search
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type [String] The type of data to search [optional] [default to [u'network', u'commercial_mode', u'line', u'line_group', u'route', u'stop_area']] [enum: network, commercial_mode, line, line_group, route, stop_area, stop_point]
count Int The maximum number of ptobjects returned [optional] [default to 10]
adminUri [String] If filled, will restrain the search within the given admin uris [optional]
depth Int The depth of objects [optional] [default to 1]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String Filter your objects [optional]

Return

PtObjects

Example

Expert.shared.ptobjectsApi.getCoverageLonLatPtObjects(
    q: "q_example", 
    lat: 3.4, 
    lon: 3.4, 
    type: ["[u'network', u'commercial_mode', u'line', u'line_group', u'route', u'stop_area']"], 
    count: 10, 
    adminUri: ["adminUri_example"], 
    depth: 1, 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }

getCoverageRegionPtObjects

Parameters

Name Type Note
q String The data to search
region String The region you want to query
type [String] The type of data to search [optional] [default to [u'network', u'commercial_mode', u'line', u'line_group', u'route', u'stop_area']] [enum: network, commercial_mode, line, line_group, route, stop_area, stop_point]
count Int The maximum number of ptobjects returned [optional] [default to 10]
adminUri [String] If filled, will restrain the search within the given admin uris [optional]
depth Int The depth of objects [optional] [default to 1]
disableGeojson Bool remove geojson from the response [optional]
disableDisruption Bool remove disruptions from the response [optional]
filter String Filter your objects [optional]

Return

PtObjects

Example

Expert.shared.ptobjectsApi.getCoverageRegionPtObjects(
    q: "q_example", 
    region: "region_example", 
    type: ["[u'network', u'commercial_mode', u'line', u'line_group', u'route', u'stop_area']"], 
    count: 10, 
    adminUri: ["adminUri_example"], 
    depth: 1, 
    disableGeojson: true, 
    disableDisruption: true, 
    filter: "filter_example"
) { result, rawData, error in
    if let error = error {
        // There was an error
    } else {
        // Use result Data or Raw Data
    }