Query station operator details
After you queried a station
you will be able to fetch the operator details through this operator
query. It will provide you with a wide range of information such as the name
, website
and logo
of the operator.
Query
To query the operator details you do need an operator id
. You can get this id
from the station
query that you just executed.
Arguments
id • ID
• Required
The operator ID.
Frequently used fields
id • ID
Unique operator ID.
name • String
Name of an operator. This property is OCPI-compliant.
website • String
Link to an operator’s website. This property is OCPI-compliant.
logo • OCPIImage
Image link to an operator’s logo. This property is OCPI-compliant.
Other fields
external_id • String
External ID of an operator provided by the operator data source.
country • String
Deprecated
ISO-3166 alpha-2 country code an operator is active in.
countries • CountryCodeAlpha2
ISO-3166 alpha-2 country codes an operator is active in.
Show CountryCodeAlpha2 enum values
contact • Contact
Contact information.
ranking • Int
Ranking level on which the operator is placed or null in case the operator is not on any ranking level.
excluded • Boolean
Flag which indicates if the operator is in the excluded list.
Response
A response can either contain a data
or an
errors
object. The response header will always return
200
as a status code.
Data object
When successful, a data
object will be returned with the
requested fields. If there are no fields present the
data
object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors
object will be returned with
more details in the extensions
object. The error object
can contain any of the following objects.
Error
ERROR_FORBIDDEN_MESSAGE
You are forbidden to execute this operation.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
Error
OPERATOR_NOT_FOUND
No operator was found with the $OPERATORID ID.