Places API

API change history

API to get places information

GetPlaceDetails

Returns place details by its identifier

Try it

Request

Request URL

https://gateway-preview.be-mo.io/Places/v1/api/Places/GetPlaceDetails[?placeId]

Request parameters

  • (optional)
    string

    Place identifier

Request headers

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

Responses

200 OK

Success

Representations

{
  "id": "string",
  "name": "string",
  "address": "string",
  "city": "string",
  "postalCode": "string",
  "country": "string",
  "coordinates": {
    "latitude": 0.0,
    "longitude": 0.0
  },
  "accessibility": {
    "publiclyAccessible": true,
    "restrictionDetails": "Private"
  },
  "operatorName": "string",
  "operatorId": "string",
  "openingTimes": {
    "twentyFourSeven": true
  },
  "evses": [
    {
      "id": "string",
      "uid": "string",
      "physicalReference": "string",
      "status": "Removed",
      "capabilities": [
        "CHARGING_PROFILE_CAPABLE"
      ],
      "remote": true,
      "locationId": "string",
      "visualReference": "string"
    }
  ],
  "connectors": [
    {
      "id": "string",
      "uid": "string",
      "status": "Removed",
      "type": "CHADEMO",
      "format": "SOCKET",
      "powerType": "AC",
      "maxPower": 0.0,
      "evseId": "string",
      "serviceId": "string",
      "connectorId": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "address": {
      "type": "string",
      "nullable": true
    },
    "city": {
      "type": "string",
      "nullable": true
    },
    "postalCode": {
      "type": "string",
      "nullable": true
    },
    "country": {
      "type": "string",
      "nullable": true
    },
    "coordinates": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": "number",
          "format": "double"
        },
        "longitude": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "accessibility": {
      "type": "object",
      "properties": {
        "publiclyAccessible": {
          "type": "boolean",
          "nullable": true
        },
        "restrictionDetails": {
          "enum": [
            "Private",
            "PayingAccess",
            "Hotel",
            "CarDealer",
            "Hospital",
            "Supermarket",
            "Office"
          ],
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "operatorName": {
      "type": "string",
      "nullable": true
    },
    "operatorId": {
      "type": "string",
      "nullable": true
    },
    "openingTimes": {
      "type": "object",
      "properties": {
        "twentyFourSeven": {
          "type": "boolean",
          "nullable": true
        }
      },
      "additionalProperties": false
    },
    "evses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "uid": {
            "type": "string",
            "nullable": true
          },
          "physicalReference": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "enum": [
              "Removed",
              "Unknown",
              "Available",
              "OutOfOrder",
              "Charging",
              "Blocked",
              "Reserved",
              "Inoperative",
              "Planned",
              "InUse"
            ],
            "type": "string"
          },
          "capabilities": {
            "type": "array",
            "items": {
              "enum": [
                "CHARGING_PROFILE_CAPABLE",
                "CREDIT_CARD_PAYABLE",
                "REMOTE_START_STOP_CAPABLE",
                "RESERVABLE",
                "RFID_READER",
                "UNLOCK_CAPABLE"
              ],
              "type": "string"
            },
            "nullable": true
          },
          "remote": {
            "type": "boolean",
            "nullable": true
          },
          "locationId": {
            "type": "string",
            "nullable": true
          },
          "visualReference": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "connectors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "nullable": true
          },
          "uid": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "enum": [
              "Removed",
              "Unknown",
              "Available",
              "OutOfOrder",
              "Charging",
              "Blocked",
              "Reserved",
              "Inoperative",
              "Planned",
              "InUse"
            ],
            "type": "string"
          },
          "type": {
            "enum": [
              "CHADEMO",
              "DOMESTIC_A",
              "DOMESTIC_B",
              "DOMESTIC_C",
              "DOMESTIC_D",
              "DOMESTIC_E",
              "DOMESTIC_F",
              "DOMESTIC_G",
              "DOMESTIC_H",
              "DOMESTIC_I",
              "DOMESTIC_J",
              "DOMESTIC_K",
              "DOMESTIC_L",
              "IEC_60309_2_single_16",
              "IEC_60309_2_three_16",
              "IEC_60309_2_three_32",
              "IEC_60309_2_three_64",
              "IEC_62196_T1",
              "IEC_62196_T1_COMBO",
              "IEC_62196_T2",
              "IEC_62196_T2_COMBO",
              "IEC_62196_T3A",
              "IEC_62196_T3C",
              "TESLA_R",
              "TESLA_S"
            ],
            "type": "string"
          },
          "format": {
            "enum": [
              "SOCKET",
              "CABLE"
            ],
            "type": "string"
          },
          "powerType": {
            "enum": [
              "AC",
              "DC"
            ],
            "type": "string"
          },
          "maxPower": {
            "type": "number",
            "format": "double"
          },
          "evseId": {
            "type": "string",
            "nullable": true
          },
          "serviceId": {
            "type": "string",
            "nullable": true
          },
          "connectorId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

400 Bad Request

Bad Request

Representations

{
  "success": true,
  "message": "string",
  "innerException": "string",
  "statusCode": 0
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "False if an exception has occured"
    },
    "message": {
      "type": "string",
      "description": "Message of the exception",
      "nullable": true
    },
    "innerException": {
      "type": "string",
      "description": "The inner exception",
      "nullable": true
    },
    "statusCode": {
      "type": "integer",
      "description": "Can be 200, 400, 401, 404, 500",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Object that describes the error"
}

401 Unauthorized

Unauthorized

Representations

{
  "status": "Success",
  "errors": [
    {
      "message": "string",
      "code": "string"
    }
  ],
  "data": {},
  "trace": {},
  "version": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "Success",
        "Warning",
        "Error"
      ],
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "nullable": true
          },
          "code": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    },
    "data": {
      "nullable": true
    },
    "trace": {
      "nullable": true
    },
    "version": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}

404 Not Found

Not Found

Representations

{
  "success": true,
  "message": "string",
  "innerException": "string",
  "statusCode": 0
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "False if an exception has occured"
    },
    "message": {
      "type": "string",
      "description": "Message of the exception",
      "nullable": true
    },
    "innerException": {
      "type": "string",
      "description": "The inner exception",
      "nullable": true
    },
    "statusCode": {
      "type": "integer",
      "description": "Can be 200, 400, 401, 404, 500",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Object that describes the error"
}

500 Internal Server Error

Server Error

Representations

{
  "success": true,
  "message": "string",
  "innerException": "string",
  "statusCode": 0
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "False if an exception has occured"
    },
    "message": {
      "type": "string",
      "description": "Message of the exception",
      "nullable": true
    },
    "innerException": {
      "type": "string",
      "description": "The inner exception",
      "nullable": true
    },
    "statusCode": {
      "type": "integer",
      "description": "Can be 200, 400, 401, 404, 500",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Object that describes the error"
}

Code samples

@ECHO OFF

curl -v -X GET "https://gateway-preview.be-mo.io/Places/v1/api/Places/GetPlaceDetails?placeId={string}"
-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("Api-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["placeId"] = "{string}";
            var uri = "https://gateway-preview.be-mo.io/Places/v1/api/Places/GetPlaceDetails?" + 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/Places/v1/api/Places/GetPlaceDetails");

            builder.setParameter("placeId", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "placeId": "{string}",
        };
      
        $.ajax({
            url: "https://gateway-preview.be-mo.io/Places/v1/api/Places/GetPlaceDetails?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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/Places/v1/api/Places/GetPlaceDetails";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"placeId={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:@"{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/Places/v1/api/Places/GetPlaceDetails');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'placeId' => '{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
    'Api-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'placeId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('gateway-preview.be-mo.io')
    conn.request("GET", "/Places/v1/api/Places/GetPlaceDetails?%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
    'Api-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'placeId': '{string}',
})

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

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