API Call (Example)

Please find examples for the following API calls:

• Request

• Response

Request

The following request message will search for all the public charging stations within one mile of 1692 Dell Avenue, Campbell, CA 95008.

<soapenv:Envelope  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:urn="urn:dictionary:com.chargepoint.webservices">
<soapenv:Header  xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Security soapenv:mustUnderstand="1">
<wsse:UsernameToken>
<wsse:Username>0123456789abcdef0123456789abcdef0123456789abcdef0123456</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">0123456789abcdef0123456789abcdef</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<urn:getStations>
<searchQuery>
<Address>1692 Dell Avenue</Address>
<City>Campbell</City>
<State>CA</State>
<postalCode>95008</postalCode>
<Proximity>1</Proximity>
<proximityUnit>M</proximityUnit>
</searchQuery>
</urn:getStations>
</soapenv:Body>
</soapenv:Envelope>

Response

The response returns a list of charging stations matching the request criteria.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsu:Created>2013-03-05T21:48:15.053Z</wsu:Created>
<wsu:Expires>2013-03-05T21:53:15.053Z</wsu:Expires>
</wsu:Timestamp>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<ns1:getStationsResponse xmlns:ns1="urn:dictionary:com.chargepoint.webservices">
<responseCode>100</responseCode>
<responseText>API input request executed successfully.</responseText>
<stationData>
<stationID>1:81203</stationID>
<stationManufacturer>Coulomb</stationManufacturer>
<stationModel>CT2025-HD-GW1-CCR</stationModel>
<Address>1692 Dell Ave</Address>
<City>Campbell</City>
<State>California</State>
<Country>United States</Country>
<postalCode>95008</postalCode>
<Port>
<portNumber>1</portNumber>
<stationName>CHARGEPOINT / HQ 5</stationName>
<Geo>
<Lat>37.261489868164060</Lat>
<Long>-121.957534790039060</Long>
</Geo>
<Description>Front parking lot along Dell Ave.</Description>
<Reservable>0</Reservable>
<Level>L2</Level>
<Connector>J1772</Connector>
<Voltage>240</Voltage>
<Current>30</Current>
<Power>7.2</Power>
<estimatedCost>0.00</estimatedCost>
</Port>
 
 
 
<Port>
<portNumber>2</portNumber>
<stationName>CHARGEPOINT / HQ 5</stationName>
<Geo>
<Lat>37.261489868164060</Lat>
<Long>-121.957534790039060</Long>
</Geo>
<Description>Front parking lot along Dell Ave.</Description>
<Reservable>0</Reservable>
<Level>L2</Level>
<Connector>J1772</Connector>
<Voltage>240</Voltage>
<Current>30</Current>
<Power>7.2</Power>
<estimatedCost>0.00</estimatedCost>
</Port>
<Pricing>
<Type>None</Type>
<startTime>00:00:00</startTime>
<endTime>23:59:59</endTime>
<minPrice>0.50</minPrice>
<maxPrice>0.00</maxPrice>
<unitPricePerHour>1.50</unitPricePerHour>
<unitPricePerSession>0.00</unitPricePerSession>
<unitPricePerKWh>0.00</unitPricePerKWh>
</Pricing>
<numPorts>2</numPorts>
<mainPhone>(888) 758-4389</mainPhone>
<modTimeStamp>2012-11-15T01:29:16Z</modTimeStamp>
<timezoneOffset>-08:00</timezoneOffset>
</stationData>
<stationData>
. . .
. . .
. . .
</ns1:getStationsResponse>
</soapenv:Body>
</soapenv:Envelope>