Vehicles
API change historyAPI to handle vehicle management
Request
Request URL
https://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles[?limit][&offset]Request parameters
-
(optional)number
-
(optional)number
Request headers
-
string
Access Token
Responses
200 OK
Response headers
-
(optional)integer
Accepted range.
-
(optional)string
Previous range Url.
-
(optional)string
Next range Url.
Representations
{
"version": 1,
"data": [
{
"id": "8786946b-9fe5-492a-b580-6e03154d84f1",
"externalId": "5f043d78bc262f1627fc0325",
"vehicleDetails": {
"make": "Ford",
"carModel": "Mustang Mach-E",
"edition": null,
"version": "ER RWD"
},
"battery": {
"usableKwh": 88.0,
"fullKwh": 98.7
},
"fastChargingSupport": false,
"range": {
"best": 405.0,
"worst": 359.0
},
"connectors": [
{
"power": 11.0,
"speed": 46,
"standard": "IEC_62196_T2",
"time": 570
},
{
"power": 90.0,
"speed": 430,
"standard": "IEC_62196_T2_COMBO",
"time": 43
}
],
"adapters": [],
"body": {
"seats": 5
},
"media": {
"image": {
"id": "5f1aa848657bebdd4a63893d",
"url": "https://cars.chargetrip.io/5f1aa848657bebdd4a63893d.png",
"width": null,
"height": 432,
"type": 3,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
},
"brand": {
"id": "5f6af138efe6759090895eda",
"url": "https://cars.chargetrip.io/5f6af138efe6759090895eda.png",
"width": null,
"height": 864,
"type": 1,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
}
},
"availability": {
"status": 2
},
"type": {
"fastCharging": null
}
},
{
"id": "9c8022a0-ebe0-478a-91ec-a8be41bdabed",
"externalId": "5f043b66bc262f1627fc0253",
"vehicleDetails": {
"make": "Tesla",
"carModel": "Model S",
"edition": null,
"version": "70"
},
"battery": {
"usableKwh": 69.0,
"fullKwh": 75.0
},
"fastChargingSupport": false,
"range": {
"best": 383.0,
"worst": 340.0
},
"connectors": [
{
"power": 11.0,
"speed": 43,
"standard": "IEC_62196_T2",
"time": 450
},
{
"power": 95.0,
"speed": 420,
"standard": "TESLA_S",
"time": 32
}
],
"adapters": [
{
"power": 110.0,
"speed": 460,
"standard": "IEC_62196_T2_COMBO",
"time": 40
},
{
"power": 110.0,
"speed": 460,
"standard": "CHADEMO",
"time": 40
},
{
"power": 16.5,
"speed": 66,
"standard": "IEC_62196_T2",
"time": 420
}
],
"body": {
"seats": 5
},
"media": {
"image": {
"id": "5f1aa836657beb4b7c6388f7",
"url": "https://cars.chargetrip.io/5f1aa836657beb4b7c6388f7.png",
"width": null,
"height": 432,
"type": 3,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
},
"brand": {
"id": "5f59fef933bb0764f9ca842b",
"url": "https://cars.chargetrip.io/5f59fef933bb0764f9ca842b.png",
"width": null,
"height": 864,
"type": 1,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
}
},
"availability": {
"status": 0
},
"type": {
"fastCharging": null
}
},
{
"id": "e038742c-bc66-432f-98e0-372f08a7955b",
"externalId": "5f9823867473fe7e2fbb8137",
"vehicleDetails": {
"make": "Lucid",
"carModel": "Air",
"edition": null,
"version": "Pure"
},
"battery": {
"usableKwh": 85.0,
"fullKwh": 88.0
},
"fastChargingSupport": false,
"range": {
"best": 437.0,
"worst": 387.0
},
"connectors": [
{
"power": 22.0,
"speed": 110,
"standard": "IEC_62196_T2",
"time": 285
},
{
"power": 240.0,
"speed": 1410,
"standard": "IEC_62196_T2_COMBO",
"time": 16
}
],
"adapters": [],
"body": {
"seats": 5
},
"media": {
"image": {
"id": "5fa4001c8de02a7a27e8444b",
"url": "https://cars.chargetrip.io/5fa4001c8de02a7a27e8444b.png",
"width": null,
"height": 432,
"type": 3,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
},
"brand": {
"id": "5fa400248de02a699be8444c",
"url": "https://cars.chargetrip.io/5fa400248de02a699be8444c.png",
"width": null,
"height": 864,
"type": 1,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
}
},
"availability": {
"status": 2
},
"type": {
"fastCharging": null
}
},
{
"id": "5568ff75-2d03-4471-babb-8ba19003ca3f",
"externalId": "5f043b3fbc262f1627fc0241",
"vehicleDetails": {
"make": "Volkswagen",
"carModel": "e-Golf",
"edition": null,
"version": null
},
"battery": {
"usableKwh": 20.5,
"fullKwh": 24.2
},
"fastChargingSupport": false,
"range": {
"best": 128.0,
"worst": 113.0
},
"connectors": [
{
"power": 3.7,
"speed": 19,
"standard": "IEC_62196_T2",
"time": 405
},
{
"power": 41.0,
"speed": 240,
"standard": "IEC_62196_T2_COMBO",
"time": 22
}
],
"adapters": [],
"body": {
"seats": 5
},
"media": {
"image": {
"id": "5f1aa834657bebb91a6388f0",
"url": "https://cars.chargetrip.io/5f1aa834657bebb91a6388f0.png",
"width": null,
"height": 432,
"type": 3,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
},
"brand": {
"id": "5f1aafdf657beb7e1d638998",
"url": "https://cars.chargetrip.io/5f1aafdf657beb7e1d638998.png",
"width": null,
"height": 864,
"type": 1,
"thumbnailUrl": null,
"thumbnailWidth": null,
"thumbnailHeight": null
}
},
"availability": {
"status": 0
},
"type": {
"fastCharging": null
}
}
],
"status": "Success"
}401 Unauthorized
401 description
Representations
{
"anyOf": [
{
"InvalidJWT": {
"status": "Error",
"errors": [
{
"code": "InvalidJWT",
"message": "Unable to decode the JWT."
}
],
"version": "1.0"
}
},
{
"TokenExpired": {
"status": "Error",
"errors": [
{
"code": "TokenExpired",
"message": "Lifetime validation failed, the JWT is expired."
}
],
"version": "1.0"
}
},
{
"TokenNotPresent": {
"status": "Error",
"errors": [
{
"code": "TokenNotPresent",
"message": "JWT not present."
}
],
"version": "1.0"
}
}
]
}{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
},
"x-apim-inline": true
}403 Forbidden
Forbidden
Representations
{
"status": "Error",
"errors": [
{
"code": "InvalidJWT",
"message": "Unable to decode the JWT."
}
],
"version": "1.0"
}{
"properties": {
"status": {
"enum": [
"Success",
"Error"
],
"type": "string",
"description": "Code describing the status of the response"
},
"errors": {
"type": "array",
"items": {
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code of the error."
},
"message": {
"type": "string",
"description": "Readable message describing the error."
}
}
}
},
"version": {
"type": "string",
"description": "Version number of the response"
}
}
}500 Internal Server Error
500 description
Representations
{
"version": "1.0",
"status": "Error",
"errors": [
{
"code": "ErrorCode",
"message": "Error message/description."
}
]
}{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"version": {
"type": "string"
}
},
"x-apim-inline": true
}Code samples
@ECHO OFF
curl -v -X GET "https://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles?limit={number}&offset={number}"
-H "Authorization: "
-H "Api-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("Authorization", "");
client.DefaultRequestHeaders.Add("Api-Subscription-Key", "{subscription key}");
// Request parameters
queryString["limit"] = "{number}";
queryString["offset"] = "{number}";
var uri = "https://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles?" + 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://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles");
builder.setParameter("limit", "{number}");
builder.setParameter("offset", "{number}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
request.setHeader("Api-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
"limit": "{number}",
"offset": "{number}",
};
$.ajax({
url: "https://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Api-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://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles";
NSArray* array = @[
// Request parameters
@"entities=true",
@"limit={number}",
@"offset={number}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Api-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://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Api-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'limit' => '{number}',
'offset' => '{number}',
);
$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
'Authorization': '',
'Api-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'limit': '{number}',
'offset': '{number}',
})
try:
conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("GET", "/vehicles/v1/api/vehicleprofiles?%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
'Authorization': '',
'Api-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'limit': '{number}',
'offset': '{number}',
})
try:
conn = http.client.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("GET", "/vehicles/v1/api/vehicleprofiles?%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://gateway-preview.be-mo.io/vehicles/v1/api/vehicleprofiles')
query = URI.encode_www_form({
# Request parameters
'limit' => '{number}',
'offset' => '{number}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Api-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