DFHV-wherearethetaxis-prod
API change historyRequest
Request URL
Request parameters
-
number
Format - double. The latitude of location to search around.
-
number
Format - double. The longitude of location to search around.
-
integer
Format - int32. The radius in meters.
-
(optional)boolean
if set to true will filter vehicles that are not Wheel Chair Accessible.
Request headers
Request body
Responses
200 OK
List of Available vehicles around the given location
Representations
[
{
"Vehicle": {
"PVIN": "string",
"Make": "string",
"Model": "string",
"WCA": true,
"VehicleType": "string"
},
"Driver": {
"Name": "string",
"FacecardID": "string"
},
"Location": {
"Latitude": 0.0,
"Longitude": 0.0,
"Timestamp": "string"
}
}
]{
"type": "array",
"items": {
"description": "Information about single Taxi",
"type": "object",
"properties": {
"Vehicle": {
"description": "Vehicle Info",
"type": "object",
"properties": {
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"Make": {
"description": "The make",
"type": "string"
},
"Model": {
"description": "The Model",
"type": "string"
},
"WCA": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "boolean"
},
"VehicleType": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "string"
}
}
},
"Driver": {
"description": "Driver Info",
"type": "object",
"properties": {
"Name": {
"description": "Full name of the driver",
"type": "string"
},
"FacecardID": {
"description": "FaceID of the Driver",
"type": "string"
}
}
},
"Location": {
"description": "Location Info",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "The latitude.",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "the longitude.",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "the timestamp in UTC.",
"type": "string"
}
}
}
}
}
}[
{
"Vehicle": {
"PVIN": "string",
"Make": "string",
"Model": "string",
"WCA": true,
"VehicleType": "string"
},
"Driver": {
"Name": "string",
"FacecardID": "string"
},
"Location": {
"Latitude": 0.0,
"Longitude": 0.0,
"Timestamp": "string"
}
}
]{
"type": "array",
"items": {
"description": "Information about single Taxi",
"type": "object",
"properties": {
"Vehicle": {
"description": "Vehicle Info",
"type": "object",
"properties": {
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"Make": {
"description": "The make",
"type": "string"
},
"Model": {
"description": "The Model",
"type": "string"
},
"WCA": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "boolean"
},
"VehicleType": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "string"
}
}
},
"Driver": {
"description": "Driver Info",
"type": "object",
"properties": {
"Name": {
"description": "Full name of the driver",
"type": "string"
},
"FacecardID": {
"description": "FaceID of the Driver",
"type": "string"
}
}
},
"Location": {
"description": "Location Info",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "The latitude.",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "the longitude.",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "the timestamp in UTC.",
"type": "string"
}
}
}
}
}
}<TaxiInfoArray>
<Vehicle>
<PVIN>string</PVIN>
<Make>string</Make>
<Model>string</Model>
<WCA>true</WCA>
<VehicleType>string</VehicleType>
</Vehicle>
<Driver>
<Name>string</Name>
<FacecardID>string</FacecardID>
</Driver>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Timestamp>string</Timestamp>
</Location>
</TaxiInfoArray>{
"type": "array",
"items": {
"description": "Information about single Taxi",
"type": "object",
"properties": {
"Vehicle": {
"description": "Vehicle Info",
"type": "object",
"properties": {
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"Make": {
"description": "The make",
"type": "string"
},
"Model": {
"description": "The Model",
"type": "string"
},
"WCA": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "boolean"
},
"VehicleType": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "string"
}
}
},
"Driver": {
"description": "Driver Info",
"type": "object",
"properties": {
"Name": {
"description": "Full name of the driver",
"type": "string"
},
"FacecardID": {
"description": "FaceID of the Driver",
"type": "string"
}
}
},
"Location": {
"description": "Location Info",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "The latitude.",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "the longitude.",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "the timestamp in UTC.",
"type": "string"
}
}
}
}
}
}<TaxiInfoArray>
<Vehicle>
<PVIN>string</PVIN>
<Make>string</Make>
<Model>string</Model>
<WCA>true</WCA>
<VehicleType>string</VehicleType>
</Vehicle>
<Driver>
<Name>string</Name>
<FacecardID>string</FacecardID>
</Driver>
<Location>
<Latitude>0</Latitude>
<Longitude>0</Longitude>
<Timestamp>string</Timestamp>
</Location>
</TaxiInfoArray>{
"type": "array",
"items": {
"description": "Information about single Taxi",
"type": "object",
"properties": {
"Vehicle": {
"description": "Vehicle Info",
"type": "object",
"properties": {
"PVIN": {
"description": "PVIN of the vehicle",
"type": "string"
},
"Make": {
"description": "The make",
"type": "string"
},
"Model": {
"description": "The Model",
"type": "string"
},
"WCA": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "boolean"
},
"VehicleType": {
"description": "Represents whether the vehicle is Wheel Chair Acccessbile",
"type": "string"
}
}
},
"Driver": {
"description": "Driver Info",
"type": "object",
"properties": {
"Name": {
"description": "Full name of the driver",
"type": "string"
},
"FacecardID": {
"description": "FaceID of the Driver",
"type": "string"
}
}
},
"Location": {
"description": "Location Info",
"type": "object",
"properties": {
"Latitude": {
"format": "double",
"description": "The latitude.",
"type": "number"
},
"Longitude": {
"format": "double",
"description": "the longitude.",
"type": "number"
},
"Timestamp": {
"format": "date-time",
"description": "the timestamp in UTC.",
"type": "string"
}
}
}
}
}
}500 Internal Server Error
Please contact DFHV if this error appears
Representations
503 Service Unavailable
There was an error, please try again or contact DFHV
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}?wcaEnabled={boolean}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["wcaEnabled"] = "{boolean}";
var uri = "https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}&" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}");
builder.setParameter("wcaEnabled", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"wcaEnabled": "{boolean}",
};
$.ajax({
url: "https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"wcaEnabled={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'wcaEnabled' => '{boolean}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'wcaEnabled': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('dfhv-api.terraiq.io')
conn.request("GET", "/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'wcaEnabled': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('dfhv-api.terraiq.io')
conn.request("GET", "/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://dfhv-api.terraiq.io/wherearethetaxis-prod/v1/vehicles/nearby?latitude={latitude}&longitude={longitude}&radiusMeters={radiusMeters}')
query = URI.encode_www_form({
# Request parameters
'wcaEnabled' => '{boolean}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body