Query station operators

Charge stations are often exploited by various operators. To get an overview of the operators in your station database you can use the operatorList query. All operator details are available for you to query. Keeping the number of attributes as low as possible will improve performance.

Query

The entire list of operators can be accessed using the operatorList query, along with the attributes you would like to receive. Optionally you can use pagination and filters to improve your results.

Filters

To filter your operator list you can use the query argument. You can then use name, id, external_id or country to specify how you want to filter the list.

Arguments

query input_object OperatorListQuery

Deprecated

Deprecated: Replaced by filter & search params

filter input_object OperatorListFilter

Filter operators by parameters

size scalar Int

Number of elements (count) to return, default: 10

page scalar Int

Page number to return, default: 0

Frequently used fields

id scalar ID

Unique operator ID

name scalar String

Name of an operator

website scalar String

Link to an operator’s website

Other fields

id scalar ID

Unique operator ID

external_id scalar String

External ID of an operator provided by the operator data source

name scalar String

Name of an operator

website scalar String

Link to an operator’s website

country scalar String

Deprecated

Deprecated: Not used anymore, please use countries property instead

countries list CountryCodeAlpha2

ISO-3166 alpha-2 country codes an operator is active in.

contact object Contact

Contact information

ranking scalar Int

Ranking level on which the operator is placed or null in case the operator is not on any ranking level

excluded scalar Boolean

Flag which indicates if the operator is in the excluded list

Response

If successful, the HTTP status code in the response header is 200 and the response body contains the attributes you requested.

If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.

Errors and warnings

Error

ERROR_FORBIDDEN_MESSAGE

You are forbidden to execute this operation

Error

OPERATOR_RANKING_FILTER_DUPLICATE

Operator ranking filter contains duplicate values: $DUPLICATES

Error

OPERATOR_RANKING_FILTER_NOT_ALLOWED

Operator ranking filter contains values which are not allowed: $INVALIDVALUES. Valid values from 1 till 10

Error

PAGINATION_INVALID_PAGE

Page must be an INT value higher than 0

Error

PAGINATION_INVALID_SIZE

Size must be an INT value between 1 and 1000