GE Industrial Solutions WattStation Connect Web Services Guide User Manual
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
Loading...