Reporting

API to expose transactions reporting

GetSessionsByAccount

Returns the list of transaction for a given account (optionally a given vehicle) for a given period.

Request

Request URL

https://gateway-preview.be-mo.io/reporting/v1/api/accounts/{accountId}/sessions[?from][&to][&vehicleId][&offset][&limit][&countryCode][&lastCreated]

Request parameters

accountId

string

Account id.
from (optional)

string

Sessions started from this date (YYYY-MM-DD).
to (optional)

string

Sessions started until this date (YYYY-MM-DD).
vehicleId (optional)

string

vehicleId
offset (optional)

integer

Offset (page) index
limit (optional)

integer

Number of results per page
countryCode (optional)

string

Country codes in ALPHA-2 format (ISO 3166).
lastCreated (optional)

string

Last created sessions (YYYY-MM-DD)

Request headers

Authorization

string

Access Token
Api-Subscription-Key

string

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

Responses

200 OK

Response headers

accept-range (optional)

integer

Accepted range.
prev-range (optional)

string

Previous range Url.
next-range (optional)

string

Next range Url.

Representations

application/json

{
  "status": "Success",
  "errors": null,
  "data": [
    {
      "address": "HOLZMARKTSTR. 36-42   HOLZMARKTSTR. 36-42  ",
      "cityKey": "BERLIN",
      "countryCode": "DE",
      "isRfid": false,
      "latitude": 52.511399,
      "longitude": 13.428477,
      "placeId": "ND020438",
      "placeName": "BERLIN HOLZMARKTSTR. 36-42",
      "placeNetwork": "Total",
      "rfid": "123456789",
      "sessionEndDate": "2021-02-11T03:38:10Z",
      "sessionId": "3fc8e82f-ec81-4ba3-a021-00d9db4c86db",
      "sessionStartDate": "2021-02-11T03:37:49Z",
      "timeZone": "+01:00",
      "transactions": [
        {
          "currencyKey": "EUR",
          "productCategory": "Fueling",
          "productFamily": "Diesel",
          "productCode": "B7",
          "quantity": 16.53,
          "quantityUnit": "L",
          "tariffCode": null,
          "totalAmount": 20.0,
          "transactionDate": "2021-02-11T03:38:10Z",
          "unitPrice": 1.21
        }
      ],
      "vehicleId": "ba7a3db7-a7de-42d9-8d16-f4bc7bc687a1",
      "zipCode": "10243"
    },
    {
      "address": "HOLZMARKTSTR. 36-42   HOLZMARKTSTR. 36-42  ",
      "cityKey": "BERLIN",
      "countryCode": "DE",
      "isRfid": false,
      "latitude": 52.511399,
      "longitude": 13.428477,
      "placeId": "ND020438",
      "placeName": "BERLIN HOLZMARKTSTR. 36-42",
      "placeNetwork": "Total",
      "rfid": "123456789",
      "sessionEndDate": "2021-02-11T03:36:02Z",
      "sessionId": "c63c260e-0f34-4b6e-b5bf-d1c0554295f1",
      "sessionStartDate": "2021-02-11T03:35:40Z",
      "timeZone": "+01:00",
      "transactions": [
        {
          "currencyKey": "EUR",
          "productCategory": "Fueling",
          "productFamily": "Diesel",
          "productCode": "B7",
          "quantity": 12.4,
          "quantityUnit": "L",
          "tariffCode": null,
          "totalAmount": 15.0,
          "transactionDate": "2021-02-11T03:36:02Z",
          "unitPrice": 1.21
        }
      ],
      "vehicleId": "ba7a3db7-a7de-42d9-8d16-f4bc7bc687a1",
      "zipCode": "10243"
    }
  ],
  "trace": null,
  "version": "1.0"
}

400 Bad Request

Representations

application/json

{
  "anyOf": [
    {
      "InvalidFromDate": {
        "status": "Error",
        "errors": [
          {
            "message": "from must be a valid date (YYYY-MM-DD)",
            "code": "ArgumentException"
          }
        ],
        "data": null,
        "trace": null,
        "version": "1.0"
      }
    },
    {
      "InvalidToDate": {
        "status": "Error",
        "errors": [
          {
            "message": "to must be a valid date (YYYY-MM-DD)",
            "code": "ArgumentException"
          }
        ],
        "data": null,
        "trace": null,
        "version": "1.0"
      }
    }
  ]
}

401 Unauthorized

401 description

Representations

application/json

Sample
Schema

{
  "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

application/json

Sample
Schema

{
  "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

Representations

application/json

{
  "status": "Error",
  "errors": [
    {
      "message": "The specified resource was not found",
      "code": "ResourceNotFound"
    }
  ],
  "data": null,
  "trace": null,
  "version": "1.0"
}

500 Internal Server Error

500 description

Representations

application/json

Sample
Schema

{
  "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/reporting/v1/api/accounts/{accountId}/sessions?from={string}&to={string}&vehicleId={string}&offset={integer}&limit={integer}&countryCode={string}&lastCreated={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["from"] = "{string}";
            queryString["to"] = "{string}";
            queryString["vehicleId"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["countryCode"] = "{string}";
            queryString["lastCreated"] = "{string}";
            var uri = "https://gateway-preview.be-mo.io/reporting/v1/api/accounts/{accountId}/sessions?" + 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/reporting/v1/api/accounts/{accountId}/sessions");

            builder.setParameter("from", "{string}");
            builder.setParameter("to", "{string}");
            builder.setParameter("vehicleId", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("countryCode", "{string}");
            builder.setParameter("lastCreated", "{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
            "from": "{string}",
            "to": "{string}",
            "vehicleId": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "countryCode": "{string}",
            "lastCreated": "{string}",
        };
      
        $.ajax({
            url: "https://gateway-preview.be-mo.io/reporting/v1/api/accounts/{accountId}/sessions?" + $.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/reporting/v1/api/accounts/{accountId}/sessions";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"from={string}",
                         @"to={string}",
                         @"vehicleId={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"countryCode={string}",
                         @"lastCreated={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/reporting/v1/api/accounts/{accountId}/sessions');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'from' => '{string}',
    'to' => '{string}',
    'vehicleId' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'countryCode' => '{string}',
    'lastCreated' => '{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
    'from': '{string}',
    'to': '{string}',
    'vehicleId': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'countryCode': '{string}',
    'lastCreated': '{string}',
})

try:
    conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/reporting/v1/api/accounts/{accountId}/sessions?%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
    'from': '{string}',
    'to': '{string}',
    'vehicleId': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'countryCode': '{string}',
    'lastCreated': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'from' => '{string}',
    'to' => '{string}',
    'vehicleId' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'countryCode' => '{string}',
    'lastCreated' => '{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