GE Energy
™
WattStation
Web Services Guide
Connect
2
WattStation™ Connect Web Services Guide
Contents
WattStation™ Connect Web Services .......................................................................................... 3
Overview of WattStation Connect Web Services .......................................................................................... 3
Setting up user credentials for Web Services ................................................................................................. 3
Accessing Web Services ........................................................................................................................................... 3
Overview of GetStationDetails Web Service ................................................................................................... 4
GetStationDetailsRequest .................................................................................................................................. 4
GetStationDetailsResponse............................................................................................................................... 4
Overview of GetPublicStations Web Service ................................................................................................... 7
GetPublicStationsRequest ................................................................................................................................. 7
GetPublicStationsResponse .............................................................................................................................. 8
Overview of GetOwnerStations Web Service............................................................................................... 10
GetOwnerStationsRequest .............................................................................................................................. 10
GetOwnerStationsResponse ........................................................................................................................... 10
Overview of GetOwnerStationsDetailed Web Service ............................................................................. 13
GetOwnerStationsDetailedRequest ............................................................................................................ 13
GetOwnerStationsDetailedResponse ......................................................................................................... 13
Authentication and Error Handling ................................................................................................................... 16
Example of a fault element ............................................................................................................................. 17
GE Energy ©2012 GE Company All Rights Reserved
3
WattStation™ Connect Web Services Guide
WattStation™ Connect Web Sevices
Overview of WattStation Connect Web Services
WattStation Connect provides web services that allow third-party software applications to programmatically
access data and functionality within WattStation network. These web services are defined by WSDL and
accessed via SOAP over HTTPS.
WattStation Connect provides the following web services:
GetStationDetails
GetPublicStations
GetOwnerStations
GetOwnerStationsDetailed
Every request to a WattStation Connect Web service requires authentication credentials to identify the caller
and optional parameters specific to the request. These Web services are only available to WattStation
owners with a management role.
Setting up user credentials for Web Services
Follow these steps to set up your WattStation Connect credentials and start using the Web services:
1. Go to www.gewattstation.com
2. Click Register to create a new WattStation Connect user account. If you have an existing account,
you simply log in with your username and password.
Now you can access all web services provided by WattStation Connect by passing your credentials to each
Web service call.
Accessing Web Services
The EVSEwebservices.wsdl files are located at:
https://services.gewattstation.com/EVSEWebServices/services/EVSEWebServices?WSDL
GE Energy ©2012 GE Company All Rights Reserved
4
Element
Type
Description
username
string
Your WattStation Connect user name.
password
string
Your WattStation Connect password.
stationSerialNumber
string
A serial number printed on the WattStation unit you
own.
Element
Type
Description
stationSerialNumber
string
A serial number printed on the WattStation unit you
own.
longitude
string
The longitude coordinates of the WattStation‟s
physical location.
latitude
string
The latitude coordinates of the WattStation‟s physical
location.
postalCode
string
The postal code for the region in which the
WattStation is located.
WattStation™ Connect Web Services Guide
Overview of GetStationDetails Web Service
The GetStationDetails web service allows your application to request information about a specific
charging station you own. To call this service, you must provide the owner‟s authentication credentials. The
web service returns information about the charging station with the given serial number.
GetStationDetailsRequest
Table 1: GetStationDetailsRequest Elements and Description
GetStationDetailsResponse
By default, responses include all response fields available to your account.
Table 2: GetStationDetailsResponse Elements and Description
GE Energy ©2012 GE Company All Rights Reserved
5
timeZone
string
The time zone in which the charging station is located.
Values are derived from standard timeZone values
obtained from the Java API call
java.util.TimeZone.getAvailableIDs().
The values can be (but not limited to) one of:
US/Samoa
US/Aleutian
US/Hawaii
US/Alaska
US/Pacific
US/Arizona
US/Mountain
US/Central
US/Eastern
US/Michigan
Atlantic/Bermuda
America/Araguaina
America/Noronha
Atlantic/Azores
Europe/Belfast
Europe/Dublin
Europe/Amsterdam
Europe/Andorra
Europe/Athens
Europe/Bucharest
Europe/Moscow
Europe/Samara
Asia/Baku
Asia/Aqtau
Asia/Almaty
Asia/Bangkok
Asia/Brunei
Asia/Dili
Asia/Sakhalin
Asia/Anadyr
Pacific/Auckland
Pacific/Enderbury
Pacific/Kiritimati
displayName
string
The name used to identify this charging station. The
display name could be a business name or the serial
number.
maxCurrent
string
The maximum electrical current allowed at your
WattStation. For example, 30 amps.
chargeLevel
string
By default, Level 2 charging is selected. WattStations
support Level 2 charging which provides faster
charging with service needs of 208-240VAC at 40A.
operationalMode
string
The operational mode for your WattStation can be one
of the following:
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
6
Online
Offline
Unknown
If set to „offline,‟ all communication between the
charging station and the WattStation Connect servers
is disabled.
accessType
string
Indicates if this station is publicly available, available
for restricted or private use only, or if the station is not
yet provisioned for use.
The access to your WattStation can be set to one of
the following options:
Public
Private
Not Provisioned
status
string
Indicates the status of your WattStation. For example,
it indicates if a vehicle is connected or if the
WattStation is idle. Possible status values include:
• Available
• Connected
• Charging
• Failure (if you are the owner,
otherwise reported as
"Unavailable")
• Unavailable
• Unknown
• Not Communicating
stationMake
string
The default value is „GE‟.
stationModel
string
The default model is WattStation Pedestal.
provisionedDate
dateTime
The exact date on which this WattStation was
provisioned for use.
WarrantyStartDate
dateTime
The date on which manufacturer‟s warranty on the
charging station begins.
warrantyLength
string
The warranty length (in days) since the
WarrantyStartDate for the charging station.
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
7
Element
Type
Description
username
string
The user name you established when creating your
WattStation Connect user account.
password
string
Your password for this account.
minLongitude
double
The minimum longitude coordinates to define the start
range of an area for which you wish to retrieve
information for public charging stations.
maxLongitude
double
The maximum longitude coordinates to define the end
range of an area for which you wish to retrieve
information for public charging stations.
minLatitude
double
The minimum latitude coordinates to define the start
range of an area for which you wish to retrieve
information for public charging stations.
maxLatitude
double
The maximum latitude coordinates to define the end
range of an area for which you wish to retrieve
information for public charging stations.
WattStation™ Connect Web Services Guide
Overview of GetPublicStations Web Service
The GetPublicStations web service allows your application to locate all charging stations that are
publicly available within a specified geographical range. Use this API to locate public charging stations within
latitude and longitude parameters specified.
GetPublicStations returns a list of stations matching your search criteria, and provides details such as
address, availability, and the cost listed at the station (if price data is available).
GetPublicStationsRequest
Table 3: GetPublicStations Request Elements and Description
GE Energy ©2012 GE Company All Rights Reserved
8
Element
Type
Description
stationSerialNumber
string
Serial number of the charging stations.
longitude
string
The longitude coordinates of the WattStation‟s
physical location.
latitude
string
The latitude coordinates of the WattStation‟s physical
location.
address
string
The address for the publicly available charging station.
postalCode
string
The postal code for the region in which the charging
station is located.
timeZone
string
The time zone in which the charging station is located.
Values are derived from standard timeZone values
obtained from the Java API call
java.util.TimeZone.getAvailableIDs().
The values can be (but not limited to) one of:
US/Samoa
US/Aleutian
US/Hawaii
US/Alaska
US/Pacific
US/Arizona
US/Mountain
US/Central
US/Eastern
US/Michigan
Atlantic/Bermuda
America/Araguaina
America/Noronha
Atlantic/Azores
Europe/Belfast
Europe/Dublin
Europe/Amsterdam
Europe/Andorra
Europe/Athens
Europe/Bucharest
Europe/Moscow
Europe/Samara
Asia/Baku
Asia/Aqtau
Asia/Almaty
Asia/Bangkok
Asia/Brunei
Asia/Dili
WattStation™ Connect Web Services Guide
GetPublicStationsResponse
The following response is generated according to the request parameters you set up:
Table 4: GetPublicStations Response Elements and Description
GE Energy ©2012 GE Company All Rights Reserved
9
Asia/Sakhalin
Asia/Anadyr
Pacific/Auckland
Pacific/Enderbury
Pacific/Kiritimati
chargeLevel
string
By default, Level 2 charging is selected. WattStations
support Level 2 charging which provides faster
charging with service needs of 208-240VAC at 40A.
status
string
Indicates the status of your WattStation. For example,
it indicates if a vehicle is connected or if the
WattStation is idle. Possible status values include:
• Available
• Connected
• Charging
• Failure (if you are the owner,
otherwise reported as
"Unavailable")
• Unavailable
• Unknown
• Not Communicating
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
10
Element
Type
Description
username
string
The user name you established when creating your
WattStation Connect user account.
password
string
The password for your WattStation Connect user
account.
Element
Type
Description
stationSerialNumber
string
A serial number printed on the WattStation unit you
own.
longitude
string
The longitude coordinates of the WattStation‟s
physical location.
latitude
string
The latitude coordinates of the WattStation‟s
physical location.
address
string
The address for location of the charging station.
postalCode
string
The postal code for the region in which the
WattStation is located.
WattStation™ Connect Web Services Guide
Overview of GetOwnerStations Web Service
Use the GetOwnerStations Web service to get a summary of all charging stations that you own.
GetOwnerStationsRequest
Table 5: GetOwnerStations Request Elements and Description
GetOwnerStationsResponse
The response returned includes the following information based on the owner credentials provided
in the request.
Table 6: GetOwnerStations Response Elements and Description
GE Energy ©2012 GE Company All Rights Reserved
11
timeZone
string
The time zone in which the charging station is
located. Values are derived from standard timeZone
values obtained from the Java API call
java.util.TimeZone.getAvailableIDs().
The values can be (but not limited to)
one of:
US/Samoa
US/Aleutian
US/Hawaii
US/Alaska
US/Pacific
US/Arizona
US/Mountain
US/Central
US/Eastern
US/Michigan
Atlantic/Bermuda
America/Araguaina
America/Noronha
Atlantic/Azores
Europe/Belfast
Europe/Dublin
Europe/Amsterdam
Europe/Andorra
Europe/Athens
Europe/Bucharest
Europe/Moscow
Europe/Samara
Asia/Baku
Asia/Aqtau
Asia/Almaty
Asia/Bangkok
Asia/Brunei
Asia/Dili
Asia/Sakhalin
Asia/Anadyr
Pacific/Auckland
Pacific/Enderbury
Pacific/Kiritimati
chargeLevel
string
By default, Level 2 charging is selected. WattStations
support Level 2 charging which provides faster
charging with service needs of 208-240VAC at 40A.
status
string
Indicates the status of your WattStation. For
example, it indicates if a vehicle is connected or if
the WattStation is idle. Possible status values
include:
• Available
• Connected
• Charging
• Failure (if you are the owner,
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
12
otherwise reported as
"Unavailable")
• Unavailable
• Unknown
• Not Communicating
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
13
Element
Type
Description
username
string
The user name you established when creating your
WattStation Connect user account.
password
string
The password for your WattStation Connect user
account.
Element
Type
Description
stationSerialNumber
string
A serial number printed on the WattStation unit you
own.
longitude
string
The longitude coordinates of the WattStation‟s
physical location.
latitude
string
The latitude coordinates of the WattStation‟s
physical location.
address
string
The address for the publicly available charging
station.
postalCode
string
The postal code for the region in which the
WattStation™ Connect Web Services Guide
Overview of GetOwnerStationsDetailed Web Service
Use the GetOwnerStationsDetailed Web service to get detailed information for all charging
stations owned by a specific owner.
GetOwnerStationsDetailedRequest
Table 5: GetOwnerStationsDetailed Request Elements and Description
GetOwnerStationsDetailedResponse
By default, the response returned includes the following information based on the owner
credentials provided.
Table 6: GetOwnerStationsDetailed Response Elements and Description
GE Energy ©2012 GE Company All Rights Reserved
14
WattStation is located.
timeZone
string
The time zone in which the charging station is
located. Values are derived from standard timeZone
values obtained from the Java API call
java.util.TimeZone.getAvailableIDs().
The values can be (but not limited to) one of:
US/Samoa
US/Aleutian
US/Hawaii
US/Alaska
US/Pacific
US/Arizona
US/Mountain
US/Central
US/Eastern
US/Michigan
Atlantic/Bermuda
America/Araguaina
America/Noronha
Atlantic/Azores
Europe/Belfast
Europe/Dublin
Europe/Amsterdam
Europe/Andorra
Europe/Athens
Europe/Bucharest
Europe/Moscow
Europe/Samara
Asia/Baku
Asia/Aqtau
Asia/Almaty
Asia/Bangkok
Asia/Brunei
Asia/Dili
Asia/Sakhalin
Asia/Anadyr
Pacific/Auckland
Pacific/Enderbury
Pacific/Kiritimati
displayName
string
The name used to identify this charging station. The
display name could be a business name or the serial
number.
maxCurrent
string
The maximum electrical current allowed at your
WattStation. For example, 30 amps.
chargeLevel
string
By default, Level 2 charging is selected. WattStations
support Level 2 charging which provides faster
charging with service needs of 208-240VAC at 40A.
operationalMode
string
The operational mode for your WattStation can be
one of the following:
Online
Offline
Unknown
If set to „offline,‟ all communication between the
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
15
charging station and the WattStation Connect
servers is disabled.
accessType
string
Indicates if this station is publicly available, available
for restricted or private use only, or if the station is
not yet provisioned for use.
The access to your WattStation can be set to one of
the following options:
Public
Private
Not Provisioned
status
string
Indicates the status of your WattStation. For
example, it indicates if a vehicle is connected or if
the WattStation is idle. Possible status values
include:
• Available
• Connected
• Charging
• Failure (if you are the owner,
otherwise reported as
"Unavailable")
• Unavailable
• Unknown
• Not Communicating
stationMake
string
The default value is GE.
stationModel
string
The default model is WattStation Pedestal.
provisionedDate
dateTime
The exact date on which this WattStation was
provisioned for use.
warrantyStartDate
dateTime
The date on which manufacturer‟s warranty on the
charging station begins.
warrantyLength
string
The warranty length (in days) since the
WarrantyStartDate for the charging station.
WattStation™ Connect Web Services Guide
GE Energy ©2012 GE Company All Rights Reserved
16
Code
Error message
Description
100
Invalid username or password
Bad login credentials
101
Insufficient privileges to perform
this operation
The user does not have permissions to access
this web service.
103
Service Exception
General exception thrown when the backend
service cannot perform the operation because of
an internal error.
104
Station not found
The station serial number was not found.
105
Invalid parameter
A parameter that was passed to the service is
invalid.
WattStation™ Connect Web Services Guide
Authentication and Error Handling
If an error occurs during the processing of a service, a generic exception of type
EVSEWebServiceException is thrown. The EVSEWebServiceException exception
represents all exceptions that can occur during a web service call.
To understand why the exception was thrown, you must look at attributes within the
EVSEWebServiceException. The attributes “message” and “EVSEError” provide relevant information
regarding the cause of the exception.
The attribute „message‟ is the string description of the exception.
The attribute „errorCode‟ within the „EVSEError‟ object is the unique integer value
representing the reason for this exception.
Listed below are the types of errors that can occur during the processing of a service, along with
the error message and error code values.
Table 7: Error codes and corresponding error messages
If your client does not support exceptions, then exceptions are returned to the client as part of the
SOAP envelope response. In the SOAP envelope, there will be an element <soap:fault>. The
<soap:fault> element will hold the reason for the exception and the error code.
GE Energy ©2012 GE Company All Rights Reserved
17
WattStation™ Connect Web Services Guide
Example of a fault element
Given below is an example of the <soap:fault> element for Bad Login Credentials:
The <faultstring> element is the „message‟ attribute of the EVSEWebServiceException. In
this case, it gives a message „Bad Login Credentials.‟
The <errorCode> element provides the „errorCode‟ for the EVSEError object of the
EVSEWebServiceException. In this example, the error code is 100.
Refer to Table 7 for a description of error messages and corresponding error codes.
NOTE: WattStation Connect RESTful Web services will be available in September, 2012.
GE Energy ©2012 GE Company All Rights Reserved
GE Energy
41 Woodford Ave.
Plainville, CT 06062
www.geindustrial.com
© 2012 GE Energy, Inc. All rights reserved.
WattStation™ is a trademark of General Electric Company. All other trademarks are the property of their respective owners.
Confidential Information - This document contains Confidential/Proprietary Information of GE Energy and/or its suppliers or vendors. Distribution or
reproduction prohibited without permission.
THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS", WITH NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, WHETHER EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER
LIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLY DISCLAIMED.
DET-771 (6/12)
Loading...