Query

Unknown

Arguments

query· OperatorListQuery

Query parameters to filter operators.

search· String

Search operator by name.

filter· OperatorListFilter

Criteria to filter operators.

countries· CountryCodeAlpha2

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

ranking· Int

List of ranking level(s) to be retrieved. Valid values are 1 to 10. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

excluded· Boolean

Only retrieve operators that are in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

ranking_levels· OperatorRankingLevelsFilter

List of ranking level(s) to be retrieved. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

excluded_countries· CountryCodeAlpha2

List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

size· Int

Number of elements (count) to return.

page· Int

Page number to return.

Fields

id· ID

Unique operator ID.

external_id· String

External ID of an operator provided by the operator data source.

name· String

Name of an operator.

website· String

Link to an operator’s website.

logo· OCPIImage

Image link to an operator’s logo.

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.

contact· Contact

Contact information.

ranking· Int· deprecated

Ranking level on which the operator is placed or null in case the operator is not on any ranking level. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

excluded· Boolean· deprecated

Flag which indicates if the operator is in the excluded list. Default operator preference applied to routes created through newRoute mutation if no operator preference is specified in the request.

ranking_levels· OperatorRankingLevels

Ranking configuration for the operator. An operator can be ranked on different levels in different countries. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

excluded_countries· CountryCodeAlpha2

List of countries where the operator is excluded. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

avoided_countries· CountryCodeAlpha2

List of countries where the operator is avoided. Default operator preference applied to routes created through createRoute mutation if no operator preference is specified in the request.

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

error_forbidden_message
operation_not_allowed
operator_filter_invalid
operator_ranking_filter_duplicate
operator_ranking_filter_not_allowed
pagination_invalid_page
pagination_invalid_size
rate_limit_exceeded

Was this helpful?