Services
API change historyAPI to handle Services
Request
Request URL
https://gateway-preview.be-mo.io/services/v1/api/products/{productId}/services
Request parameters
-
string
Product id retrieved from GetProductsAround
Request headers
-
string
A JwtToken generated by GetVehicleToken
Responses
200 OK
Representations
{
"version": 1,
"data": [
{
"id": "c43699-lQKnQkVNT19MMc4AgAAAqkJFTU9fTDFfRTGRrUNoYWRlbW9fQ2FibGU=",
"isAllowed": true,
"physicalReference": "BEMO_L1_E1_external",
"productCode": "E_Fast_DC",
"productId": "c43699-kwKnQkVNT19MMc4AgAAA",
"productCategory": "Charging",
"status": "Available",
"latitude": 48.83263166,
"longitude": 2.28681486,
"physicalEquipments": [
"Chademo_Cable"
],
"equipementType": "chargePoint",
"score": {
"digitalScore": 92.0,
"physicalScore": 87.0,
"networkDigitalScore": 56.0,
"networkPhysicalScore": 75.0
},
"connectors": [
{
"id": "BEMO_L1_E1_CHADEMO",
"standard": "CHADEMO",
"format": "CABLE",
"powerType": "DC",
"voltage": 400,
"amperage": 125,
"power": 50,
"tariffId": "e3b1d672-766e-401e-9e5a-cc31c0640959"
}
]
},
{
"id": "c43699-lQKnQkVNT19MMc4AgAAAqkJFTU9fTDFfRTGRt2Nvbm5lY3Rvci5DaGFkZW1vX0NhYmxl",
"isAllowed": true,
"physicalReference": "BEMO_L1_E1_external",
"productCode": "E_Fast_DC",
"productId": "c43699-kwKnQkVNT19MMc4AgAAA",
"productCategory": "Charging",
"status": "Available",
"latitude": 48.83263166,
"longitude": 2.28681486,
"physicalEquipments": [
"connector.Chademo_Cable"
],
"equipementType": "chargePoint",
"score": {
"digitalScore": 92.0,
"physicalScore": 87.0,
"networkDigitalScore": 56.0,
"networkPhysicalScore": 75.0
},
"connectors": [
{
"id": "BEMO_L1_E1_CHADEMO",
"standard": "CHADEMO",
"format": "CABLE",
"powerType": "DC",
"voltage": 400,
"amperage": 125,
"power": 50,
"tariffId": "e3b1d672-766e-401e-9e5a-cc31c0640959"
}
]
},
{
"id": "c43699-lQKnQkVNT19MMc4AgAAAqkJFTU9fTDFfRTGRt2Nvbm5lY3Rvci5jaGFkZW1vX2NhYmxl",
"isAllowed": true,
"physicalReference": "BEMO_L1_E1_external",
"productCode": "E_Fast_DC",
"productId": "c43699-kwKnQkVNT19MMc4AgAAA",
"productCategory": "Charging",
"status": "Available",
"latitude": 48.83263166,
"longitude": 2.28681486,
"physicalEquipments": [
"connector.chademo_cable"
],
"equipementType": "chargePoint",
"score": {
"digitalScore": 92.0,
"physicalScore": 87.0,
"networkDigitalScore": 56.0,
"networkPhysicalScore": 75.0
},
"connectors": [
{
"id": "BEMO_L1_E1_CHADEMO",
"standard": "CHADEMO",
"format": "CABLE",
"powerType": "DC",
"voltage": 400,
"amperage": 125,
"power": 50,
"tariffId": "e3b1d672-766e-401e-9e5a-cc31c0640959"
}
]
}
],
"status": "Success",
"errors": null
}
{
"allOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique id of the product"
},
"isAllowed": {
"type": "boolean",
"description": "Indicates whether or not this service is allowed"
},
"physicalReference": {
"type": "string",
"description": "it coresponds to the number of pump or of EVSE"
},
"productCode": {
"enum": [
"B7",
"B10"
],
"type": "string",
"description": "Product code"
},
"productId": {
"type": "string",
"description": "Unique id of the product"
},
"productCategory": {
"enum": [
"Fueling",
"Charging",
"Washing",
"Parking"
],
"type": "string",
"description": "Category of the product"
},
"status": {
"enum": [
"Available",
"InUse",
"OutOfOrder",
"Reserved",
"Unknown"
],
"type": "string",
"description": "Product availability status"
},
"latitude": {
"maximum": 90.0,
"minimum": -90.0,
"type": "number",
"description": "Latitude of the place."
},
"longitude": {
"maximum": 180.0,
"minimum": -180.0,
"type": "number",
"description": "Longitude of the place."
},
"physicalEquipments": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of physical equipments."
}
}
}
}
}
}
]
}
400 Bad Request
Bad request
Representations
{
"status": "Error",
"errors": [
{
"message": "Product Id is invalid",
"code": "ValidationException"
}
],
"data": null,
"trace": null,
"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"
}
}
}
401 Unauthorized
Unauthorized
Representations
{
"version": 1,
"status": "Error",
"errors": [
{
"code": "InvalidJWT",
"message": "Unable to decode the JWT."
}
]
}
{
"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"
}
}
}
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
Internal server error
Representations
{
"status": "Error",
"errors": [
{
"code": "ErrorCode",
"message": "Error message/description."
}
],
"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"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://gateway-preview.be-mo.io/services/v1/api/products/{productId}/services"
-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}");
var uri = "https://gateway-preview.be-mo.io/services/v1/api/products/{productId}/services?" + 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/services/v1/api/products/{productId}/services");
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
};
$.ajax({
url: "https://gateway-preview.be-mo.io/services/v1/api/products/{productId}/services?" + $.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/services/v1/api/products/{productId}/services";
NSArray* array = @[
// Request parameters
@"entities=true",
];
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/services/v1/api/products/{productId}/services');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Api-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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({
})
try:
conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("GET", "/services/v1/api/products/{productId}/services?%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({
})
try:
conn = http.client.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("GET", "/services/v1/api/products/{productId}/services?%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/services/v1/api/products/{productId}/services')
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