Community
API change historyAPI to get drivers feedbacks
Request
Request URL
https://gateway-preview.be-mo.io/community/v1/api/{placeId}/feedbacksRequest parameters
Request headers
-
string
Access token
Request body
Context informations and user feedbacks
{
"vehicleId": "efa96a5f-fdsb6-4997-ae32-fdsqfdfd",
"date": "2020-12-31T00:00:00Z",
"physicalReference": [
"efa96a5f-c6b6-4997-ae32-2a42d483c473",
"efa96a5f-c6b6-4997-ae32-2a42d483c473"
],
"longitude": 2.25422,
"latitude": 33.2564343,
"feedbacks": {
"accessFeedbacks": [
{
"code": "PlacePrivate",
"details": "hotel",
"comment": "Reserved to Novotel clients"
},
{
"code": "PlacePayingAccess",
"comment": "Parking with paying access"
},
{
"code": "ChargePointBlocked",
"comment": "Charge Point is blocked by an unauthorized car"
}
],
"informationFeedbacks": [
{
"code": "ChargePointInoperative",
"comment": "Charge Point is out of order. Impossible to charge my car"
}
],
"sessionFeedbacks": [
{
"code": "RfidStartFailed",
"comment": "My card is not recognized. Impossible to start the session"
}
]
},
"evaluation": {
"score": 5,
"comment": "Smooth and simple to use !"
}
}{
"required": [
"vehicleId",
"date"
],
"type": "object",
"properties": {
"vehicleId": {
"type": "string",
"description": "Vehicle identifier",
"example": "efa96a5f-fdsb6-4997-ae32-fdsqfdfd"
},
"date": {
"type": "string",
"example": "2020-12-31T00:00:00Z"
},
"physicalReference": {
"type": "array",
"items": {
"type": "string"
},
"description": "Charge point identifier displays physically on it",
"example": [
"efa96a5f-c6b6-4997-ae32-2a42d483c473",
"efa96a5f-c6b6-4997-ae32-2a42d483c473"
]
},
"longitude": {
"type": "number",
"description": "A valid longitude (-180 to 180)",
"format": "int64",
"example": 2.25422
},
"latitude": {
"type": "number",
"description": "A valid latitude (-90 to 90)",
"format": "int64",
"example": 33.2564343
},
"feedbacks": {
"type": "object",
"properties": {
"accessFeedbacks": {
"type": "array",
"items": {
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"enum": [
"PlaceNotFound",
"PlacePrivate",
"PlacePayingAccess",
"ChargePointBlocked",
"Others"
],
"type": "string",
"description": "User feedback code(s). Please refers to Community documentation and read complete list of codes and details related"
},
"details": {
"type": "string",
"description": "Additionnal suggested details for some codes",
"example": "for privatePlace : hotel, office, car dealer, private (for personnal and individual usage)"
},
"comment": {
"type": "string",
"description": "Additionnal user comment"
}
}
},
"description": "User is driving to the station",
"example": [
{
"code": "PlacePrivate",
"details": "hotel",
"comment": "Reserved to Novotel clients"
},
{
"code": "PlacePayingAccess",
"comment": "Parking with paying access"
},
{
"code": "ChargePointBlocked",
"comment": "Charge Point is blocked by an unauthorized car"
}
]
},
"informationFeedbacks": {
"type": "array",
"items": {
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"enum": [
"ChargePointInoperative",
"ChargePointAvailabilityError",
"ChargePointPriceError",
"ChargePointPowerError",
"Others"
],
"type": "string",
"description": "User feedback code(s). Please refers to Community documentation and read complete list of codes and details related"
},
"details": {
"type": "string",
"description": "Additionnal suggested details for some codes"
},
"comment": {
"type": "string",
"description": "Additionnal user comment"
}
}
},
"description": "Car is successfully parked and user is in front of a Charge Point or fueling pump",
"example": [
{
"code": "ChargePointInoperative",
"comment": "Charge Point is out of order. Impossible to charge my car"
}
]
},
"sessionFeedbacks": {
"type": "array",
"items": {
"required": [
"code"
],
"type": "object",
"properties": {
"code": {
"enum": [
"RfidStartFailed",
"DigitalStartFailed",
"PowerDeliveredError",
"SessionEndFailed",
"Others"
],
"type": "string",
"description": "User feedback code(s). Please refers to Community documentation and read complete list of codes and details related"
},
"details": {
"type": "string",
"description": "Additionnal suggested details for some codes"
},
"comment": {
"type": "string",
"description": "Additionnal user comment"
}
}
},
"description": "User is starting or successfully started the session",
"example": [
{
"code": "RfidStartFailed",
"comment": "My card is not recognized. Impossible to start the session"
}
]
}
},
"description": "User feedback. Please refers to Community documentation and read complete list of codes and details related"
},
"evaluation": {
"required": [
"score"
],
"type": "object",
"properties": {
"score": {
"type": "integer",
"description": "1 (worst) and 5 (best) experience"
},
"comment": {
"type": "string",
"description": "A detailed decription of how the user experienced the session"
}
},
"description": "User can share evaluation at the end of the session",
"example": {
"score": 5,
"comment": "Smooth and simple to use !"
}
}
},
"x-apim-inline": true
}Responses
201 Created
Created
400 Bad Request
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"
}
}
}404 Not Found
Not found
Representations
{
"status": "Error",
"errors": [
{
"code": "Not found",
"message": "Item not found."
}
],
"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."
}
]
}Code samples
@ECHO OFF
curl -v -X POST "https://gateway-preview.be-mo.io/community/v1/api/{placeId}/feedbacks"
-H "Authorization: "
-H "Content-Type: application/json"
-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/community/v1/api/{placeId}/feedbacks?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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/community/v1/api/{placeId}/feedbacks");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("Content-Type", "application/json");
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/community/v1/api/{placeId}/feedbacks?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Api-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/community/v1/api/{placeId}/feedbacks";
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:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/community/v1/api/{placeId}/feedbacks');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Content-Type' => 'application/json',
'Api-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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': '',
'Content-Type': 'application/json',
'Api-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("POST", "/community/v1/api/{placeId}/feedbacks?%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': '',
'Content-Type': 'application/json',
'Api-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('gateway-preview.be-mo.io')
conn.request("POST", "/community/v1/api/{placeId}/feedbacks?%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/community/v1/api/{placeId}/feedbacks')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# 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