Vehicles

API change history

API to handle vehicle management

GetVehicleList

Retrieves a list of vehicles.

Try it

Request

Request URL

https://gateway-preview.be-mo.io/vehicles/v1/api/accounts/{accountId}/vehicles[?limit][&offset][&expand][&group]

Request parameters

  • string

    Your team's private identifier for the Sandbox environment (received by email).

  • (optional)
    number
  • (optional)
    number
  • (optional)
    string

    Use this parameter to include external identifiers in vehicles response.

  • (optional)
    string

    Use this parameter to filter the vehicles by groups.

Request headers

  • string

    Access Token

  • string
    Subscription key which provides access to this API. Found in your Profile.

Responses

200 OK

Response headers

  • (optional)
    integer

    Accepted range.

  • (optional)
    string

    Previous range Url.

  • (optional)
    string

    Next range Url.

Representations

{
  "version": 1,
  "data": [
    {
      "id": "88acd2-f788d463-e132-4758-ab69-82abd75ab93c",
      "model": "Zoe",
      "connectors": [
        "iec_62196_t2_cable"
      ],
      "year": 2016,
      "brand": "Renault",
      "to": "2020-12-31T01:00:00Z",
      "allowedProducts": [
        "E_Standard"
      ],
      "accountId": "dc425ffa-c2a8-42db-b7d0-42b1a1565df7",
      "from": "2019-10-21T02:00:00Z",
      "group": "subsidiary",
      "powerMax": 59,
      "vehicleProfileId": 97,
      "tags": [
        "Jockey"
      ],
      "externalIdentifiers": [
        {
          "externalIdType": "RFID",
          "externalIdValue": "**********AZ"
        }
      ]
    },
    {
      "id": "88acd2-81399240-60a8-4c1c-b544-39839b507c5f",
      "model": "Zoe",
      "connectors": [
        "iec_62196_t2_cable"
      ],
      "year": 2016,
      "brand": "Renault",
      "to": "2020-12-31T01:00:00Z",
      "allowedProducts": [
        "E_Standard"
      ],
      "accountId": "dc425ffa-c2a8-42db-b7d0-42b1a1565df7",
      "from": "2019-10-21T02:00:00Z",
      "group": "subsidiary",
      "powerMax": 59,
      "tags": [
        "Jockey"
      ],
      "externalIdentifiers": [
        {
          "externalIdType": "RFID",
          "externalIdValue": "**********A1"
        }
      ]
    },
    {
      "id": "88acd2-71302031-03dc-4cb8-914f-5c5ee2580bf2",
      "model": "Zoe",
      "connectors": [
        "iec_62196_t2_cable"
      ],
      "year": 2016,
      "brand": "Renault",
      "to": "2020-12-31T01:00:00Z",
      "allowedProducts": [
        "E_Standard"
      ],
      "accountId": "dc425ffa-c2a8-42db-b7d0-42b1a1565df7",
      "from": "2019-10-21T02:00:00Z",
      "group": "subsidiary",
      "powerMax": 59,
      "externalIdentifiers": null
    },
    {
      "id": "88acd2-433c281f-424d-4361-9528-b8265f0f3c00",
      "model": "Zoe",
      "connectors": [
        "iec_62196_t2_cable"
      ],
      "year": 2016,
      "brand": "Renault",
      "to": "2020-12-31T01:00:00Z",
      "allowedProducts": [
        "E_Standard"
      ],
      "accountId": "dc425ffa-c2a8-42db-b7d0-42b1a1565df7",
      "from": "2019-10-21T02:00:00Z",
      "group": "subsidiary",
      "powerMax": 59,
      "externalIdentifiers": 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/accounts/{accountId}/vehicles?limit={number}&offset={number}&expand={string}&group={string}"
-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}";
            queryString["expand"] = "{string}";
            queryString["group"] = "{string}";
            var uri = "https://gateway-preview.be-mo.io/vehicles/v1/api/accounts/{accountId}/vehicles?" + 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/accounts/{accountId}/vehicles");

            builder.setParameter("limit", "{number}");
            builder.setParameter("offset", "{number}");
            builder.setParameter("expand", "{string}");
            builder.setParameter("group", "{string}");

            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}",
            "expand": "{string}",
            "group": "{string}",
        };
      
        $.ajax({
            url: "https://gateway-preview.be-mo.io/vehicles/v1/api/accounts/{accountId}/vehicles?" + $.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/accounts/{accountId}/vehicles";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"limit={number}",
                         @"offset={number}",
                         @"expand={string}",
                         @"group={string}",
                      ];
    
    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/accounts/{accountId}/vehicles');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'Api-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'limit' => '{number}',
    'offset' => '{number}',
    'expand' => '{string}',
    'group' => '{string}',
);

$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}',
    'expand': '{string}',
    'group': '{string}',
})

try:
    conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/vehicles/v1/api/accounts/{accountId}/vehicles?%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}',
    'expand': '{string}',
    'group': '{string}',
})

try:
    conn = http.client.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/vehicles/v1/api/accounts/{accountId}/vehicles?%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/accounts/{accountId}/vehicles')

query = URI.encode_www_form({
    # Request parameters
    'limit' => '{number}',
    'offset' => '{number}',
    'expand' => '{string}',
    'group' => '{string}'
})
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