Services

API change history

API to handle Services

GetServicesByPlaceId

Returns the list of equipments available in the specified location (place id).

Try it

Request

Request URL

https://gateway-preview.be-mo.io/services/v1/api/places/{placeId}/services?code={code}[&groupBy]

Request parameters

  • string

    Place id retrieved from GetProductsAround.

  • string

    Codes of the required products separated by commas. Use GetProductCodes operation from references API to get the list of product codes.

  • (optional)
    string

    When set to 'physicalReference', services are aggregated by physical reference.

Request headers

  • string

    A JwtToken generated by GetVehicleToken.

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

Responses

200 OK

Representations

{
  "status": "Success",
  "errors": null,
  "data": [
    {
      "equipmentType": "chargePoint",
      "latitude": 43.528782,
      "longitude": 5.443726,
      "physicalReference": "FR*M13*EEMNK*2",
      "services": [
        {
          "connectors": [
            {
              "amperage": 16,
              "format": "SOCKET",
              "id": "1245305",
              "power": 3.68,
              "powerType": "AC_1_PHASE",
              "standard": "DOMESTIC_F",
              "tariffId": "86276bd7-93f7-40a8-b0fb-88db7a635a6a",
              "voltage": 230
            }
          ],
          "id": "d4b88e-lAKmNDExODM5zgAQAACmOTgzODg4",
          "isAllowed": false,
          "physicalEquipments": [
            "connector.domestic_f_socket"
          ],
          "productCategory": "Charging",
          "productCode": "E_Standard",
          "productId": "d4b88e-kwKmNDExODM5zgAQAAA=",
          "score": {
            "digitalScore": null,
            "physicalScore": null,
            "networkDigitalScore": null,
            "networkPhysicalScore": null
          }
        },
        {
          "connectors": [
            {
              "amperage": 32,
              "format": "SOCKET",
              "id": "1245308",
              "power": 22.08,
              "powerType": "AC_3_PHASE",
              "standard": "IEC_62196_T2",
              "tariffId": "86276bd7-93f7-40a8-b0fb-88db7a635a6a",
              "voltage": 230
            }
          ],
          "id": "d4b88e-lAKmNDExODM5zgAgAACmOTgzODg4",
          "isAllowed": false,
          "physicalEquipments": [
            "connector.iec_62196_t2_socket"
          ],
          "productCategory": "Charging",
          "productCode": "E_Accelerated",
          "productId": "d4b88e-kwKmNDExODM5zgAgAAA=",
          "score": {
            "digitalScore": 0.0,
            "physicalScore": 0.0,
            "networkDigitalScore": 0.0,
            "networkPhysicalScore": 26.0
          }
        }
      ],
      "status": "Available"
    },
    {
      "equipmentType": "chargePoint",
      "latitude": 43.528782,
      "longitude": 5.443726,
      "physicalReference": "FR*M13*EEMNK*1",
      "services": [
        {
          "connectors": [
            {
              "amperage": 16,
              "format": "SOCKET",
              "id": "1245299",
              "power": 3.68,
              "powerType": "AC_1_PHASE",
              "standard": "DOMESTIC_F",
              "tariffId": "86276bd7-93f7-40a8-b0fb-88db7a635a6a",
              "voltage": 230
            }
          ],
          "id": "d4b88e-lAKmNDExODM5zgAQAACmOTgzODg1",
          "isAllowed": false,
          "physicalEquipments": [
            "connector.domestic_f_socket"
          ],
          "productCategory": "Charging",
          "productCode": "E_Standard",
          "productId": "d4b88e-kwKmNDExODM5zgAQAAA=",
          "score": {
            "digitalScore": null,
            "physicalScore": null,
            "networkDigitalScore": null,
            "networkPhysicalScore": null
          }
        },
        {
          "connectors": [
            {
              "amperage": 32,
              "format": "SOCKET",
              "id": "1245302",
              "power": 22.08,
              "powerType": "AC_3_PHASE",
              "standard": "IEC_62196_T2",
              "tariffId": "86276bd7-93f7-40a8-b0fb-88db7a635a6a",
              "voltage": 230
            }
          ],
          "id": "d4b88e-lAKmNDExODM5zgAgAACmOTgzODg1",
          "isAllowed": false,
          "physicalEquipments": [
            "connector.iec_62196_t2_socket"
          ],
          "productCategory": "Charging",
          "productCode": "E_Accelerated",
          "productId": "d4b88e-kwKmNDExODM5zgAgAAA=",
          "score": {
            "digitalScore": 0.0,
            "physicalScore": 0.0,
            "networkDigitalScore": 0.0,
            "networkPhysicalScore": 26.0
          }
        }
      ],
      "status": "InUse"
    }
  ],
  "trace": null,
  "version": "1.0"
}
{}

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/places/{placeId}/services?code={code}?groupBy={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["groupBy"] = "{string}";
            var uri = "https://gateway-preview.be-mo.io/services/v1/api/places/{placeId}/services?code={code}&" + 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/places/{placeId}/services?code={code}");

            builder.setParameter("groupBy", "{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
            "groupBy": "{string}",
        };
      
        $.ajax({
            url: "https://gateway-preview.be-mo.io/services/v1/api/places/{placeId}/services?code={code}&" + $.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/places/{placeId}/services?code={code}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"groupBy={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/services/v1/api/places/{placeId}/services?code={code}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'groupBy' => '{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
    'groupBy': '{string}',
})

try:
    conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/services/v1/api/places/{placeId}/services?code={code}&%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
    'groupBy': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'groupBy' => '{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