Query

Obsolète

Itinéraire

Détails de l’itinéraire

Migrer avant : T1 2027

Migrez de l’ancien service Route vers la dernière version. Le nouveau service offre un schéma réorganisé, des préférences d’opérateur par pays, un calcul d’itinéraire plus rapide et une meilleure maintenabilité.

Opérations

Ancien	Nouveau
`route`	`getRoute`
`routeUpdatedById`	`route`

Changements généraux du schéma

Typage explicite : les champs JSON auparavant flexibles sont désormais explicitement typés dans le schéma pour améliorer la structure et la validation.
Conventions de nommage : les champs utilisent désormais snake_case au lieu de camelCase.
Prise en charge des unités : les entrées numériques prennent désormais en charge différents types d’unités, exprimées sous la forme d’un objet avec value, type et une source facultative (manual, telemetry ou default).

Changements de requête et de souscription

Le nommage et le regroupement des champs ont été revus, et les champs redondants ont été supprimés. La réponse inclut désormais l’entrée d’origine enrichie des valeurs par défaut, afin de pouvoir la réutiliser pour de futurs recalculs d’itinéraire.

Niveau supérieur

Au niveau supérieur, la plupart des champs passent sous recommended, et les entrées ev, telemetry et routeRequest sont regroupées dans un seul objet request_input.

Champ	Déplacé vers
`route`	`recommended`
`alternatives`	Supprimé
`ev`	`request_input`
`telemetry`	`request_input`
`routeRequest`	`request_input`
`app`	`meta.app_id`
`status`	Inchangé

Itinéraire

Au niveau de l’itinéraire, la plupart des champs passent sous recommended en conservant leur nom, avec quelques renommages explicites.

Champ	Déplacé vers
`rangeStart*`	`range_at_origin`
`rangeEnd*`	`range_at_destination`
`charges`	`recommended.charges`
`distance`	`recommended.distance`
`consumption`	`recommended.consumption`
`chargeTime`	`recommended.durations.charging`
`polyline`	`recommended.polyline`
`pathPlot`	`recommended.path_plot`
`legs`	`recommended.legs`
`tags`	`recommended.tags`
`instructions`	Supprimé
`amenityRanking`	Supprimé
`stationsAlongRoute`	`recommended.alternative_stations`

Tronçons

Au niveau du tronçon, les autonomies suivent le même renommage que pour l’itinéraire, et les détails sur les occupants et la cargaison passent aux propriétés de localisation origin et via de chaque tronçon.

Champ	Déplacé vers
`rangeStart*`	`range_at_origin`
`rangeEnd*`	`range_at_destination`
`steps`	`sections`
`stationId`	`recommended.legs.station.station_id`

Les tronçons gagnent également un nouveau champ range_after_charge.

Changements mis en avant

La réponse introduit aussi une nouvelle forme, plus structurée, pour les sections d’itinéraire. Elle est détaillée ci-dessous.

Sections

Les étapes (steps) ont été remplacées par des sections, qui fournissent des informations plus fines, notamment les détails d’origine et de destination de chaque section.

Sections

graphql

sections {  type  tags  polyline(decimals: five)  distance(unit: meter)  duration  consumption  origin {    id    type    properties {      occupants      total_occupant_weight      total_cargo_weight    }    geometry {      type      coordinates    }  }  destination {    id    type    properties {      occupants      total_occupant_weight      total_cargo_weight    }    geometry {      coordinates      type    }  }}

Obtenez les détails d’un itinéraire précédemment calculé à l’aide de l’ancienne requête route. Les nouvelles intégrations doivent utiliser à la place la requête getRoute.

Arguments

id· ID· required

Champs

route· RouteAlternative

Recommended route.

alternatives· RouteAlternative

Available alternatives.

ev· RequestEv

EV specific data for a route request.

telemetry· JSON

Route telemetry data.

user· RequestUser·

routeRequest· RequestRoute

Route request data.

app· RouteApp

Application who requested a route.

status· RouteStatus

Route status.

RouteStatus enum values

pending

Route is queued and pending processing. Temporary status.

processing

We are computing the route for your request. Temporary status.

done

We finished computing the route, with a result. Final status.

not_found

We finished computing the route, without any result. Final status.

error

An error occurred while computing the route. Final status.

Erreurs

Les opérations peuvent échouer. Tenez compte des scénarios d'erreur suivants pour les gérer correctement. Plus sur les erreurs here.

error_forbidden_message: You are forbidden to execute this operation.
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.
rate_limit_exceeded: Rate limit exceeded.
route_not_found: No route was found with the provided ID.
route_polyline_invalid_decimals: Value for decimals number is not valid. Allowed values are 5 or 6.

Ce contenu vous a-t-il été utile ?

Exemple de requête

x-client-id

x-app-id

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972

query {
  route(id: "Enter your id here") {
    route {
      id
      type
      charges
      chargesAvailable
      chargesOccupied
      chargesUnknown
      chargesOutOfOrder
      distance
      duration
      consumption
      chargeTime
      rangeStart
      rangeStartKwh
      rangeStartPercentage
      rangeEnd
      rangeEndKwh
      rangeEndPercentage
      via
      polyline
      pathPlot {
        elevation
        averageSpeed
        consumption
        consumptionPerKm
        distance
        duration
        stateOfCharge
      }
      elevationUp
      elevationDown
      elevationMax
      saving {
        co2
        money
        currency
        averageGasPrice
        averageEnergyPrice
      }
      legs {
        id
        distance
        duration
        consumption
        rangeStart
        rangeStartKwh
        rangeStartPercentage
        rangeEnd
        rangeEndKwh
        rangeEndPercentage
        origin {
          id
          type
          geometry {
            type
            coordinates
          }
          properties
        }
        destination {
          id
          type
          geometry {
            type
            coordinates
          }
          properties
        }
        type
        name
        stationId
        operatorId
        operatorName
        operatorRanking
        chargeTime
        evse {
          uid
          evse_id
          status
          status_schedule {
            period_begin
            period_end
            status
          }
          capabilities
          connectors {
            id
            standard
            format
            power_type
            max_voltage
            max_amperage
            max_electric_power
            power
            tariff_ids
            terms_and_conditions
            last_updated
            properties
            tariff {
              country_code
              party_id
              id
              currency
              type
              tariff_alt_text {
                language
                text
              }
              tariff_alt_url
              min_price {
                excl_vat
                incl_vat
              }
              max_price {
                excl_vat
                incl_vat
              }
              elements {
                price_components {
                  type
                  price
                  vat
                  step_size
                }
                restrictions {
                  start_time
                  end_time
                  start_date
                  end_date
                  min_kwh
                  max_kwh
                  min_current
                  max_current
                  min_power
                  max_power
                  min_duration
                  max_duration
                  day_of_week
                  reservation
                }
              }
              start_date_time
              end_date_time
              energy_mix {
                is_green_energy
                energy_sources {
                  source
                  percentage
                }
                environ_impact {
                  category
                  amount
                }
                supplier_name
                energy_product_name
              }
              last_updated
            }
            prices {
              external_id
              partner
              partner_id
              product {
                name
                type
                description
                subscription_type
                subscription_fee_excl_vat
                currency
              }
              elements {
                components {
                  type
                  price_excl_vat
                  vat
                  step_size
                }
                restrictions {
                  start_time
                  end_time
                  start_date
                  end_date
                  minimum_kwh
                  maximum_kwh
                  minimum_power
                  maximum_power
                  minimum_current
                  maximum_current
                  minimum_price
                  maximum_price
                  overstay_battery_percentage {
                    minimum
                    maximum
                    unit
                  }
                  overstay_time {
                    minimum
                    maximum
                    unit
                  }
                  minimum_duration
                  maximum_duration
                  day_of_week
                  emsp_contract_date {
                    name
                    from
                    to
                  }
                  reservation
                }
              }
              last_updated
            }
            custom_properties {
              oicp {
                dynamic_power_level
                charging_modes
              }
            }
          }
          floor_level
          coordinates {
            latitude
            longitude
          }
          physical_reference
          parking_restrictions
          images {
            url
            thumbnail
            category
            type
            width
            height
          }
          last_updated
          parking_cost
          cpo_external_id
          properties
          custom_properties {
            oicp {
              authentication_modes
              max_capacity
              payment_options
              value_added_services
              additional_info {
                lang
                value
              }
              is_hubject_compatible
              hardware_manufacturer
            }
          }
        }
        connector {
          id
          standard
          format
          power_type
          max_voltage
          max_amperage
          max_electric_power
          power
          tariff_ids
          terms_and_conditions
          last_updated
          properties
          tariff {
            country_code
            party_id
            id
            currency
            type
            tariff_alt_text {
              language
              text
            }
            tariff_alt_url
            min_price {
              excl_vat
              incl_vat
            }
            max_price {
              excl_vat
              incl_vat
            }
            elements {
              price_components {
                type
                price
                vat
                step_size
              }
              restrictions {
                start_time
                end_time
                start_date
                end_date
                min_kwh
                max_kwh
                min_current
                max_current
                min_power
                max_power
                min_duration
                max_duration
                day_of_week
                reservation
              }
            }
            start_date_time
            end_date_time
            energy_mix {
              is_green_energy
              energy_sources {
                source
                percentage
              }
              environ_impact {
                category
                amount
              }
              supplier_name
              energy_product_name
            }
            last_updated
          }
          prices {
            external_id
            partner
            partner_id
            product {
              name
              type
              description
              subscription_type
              subscription_fee_excl_vat
              currency
            }
            elements {
              components {
                type
                price_excl_vat
                vat
                step_size
              }
              restrictions {
                start_time
                end_time
                start_date
                end_date
                minimum_kwh
                maximum_kwh
                minimum_power
                maximum_power
                minimum_current
                maximum_current
                minimum_price
                maximum_price
                overstay_battery_percentage {
                  minimum
                  maximum
                  unit
                }
                overstay_time {
                  minimum
                  maximum
                  unit
                }
                minimum_duration
                maximum_duration
                day_of_week
                emsp_contract_date {
                  name
                  from
                  to
                }
                reservation
              }
            }
            last_updated
          }
          custom_properties {
            oicp {
              dynamic_power_level
              charging_modes
            }
          }
        }
        plugsAvailable
        plugsOccupied
        plugsUnknown
        plugsOutOfOrder
        plugsCount
        polyline
        steps {
          id
          type
          polyline
          distance
          duration
          consumption
        }
        tags
        cargo
        occupants
      }
      instructions {
        points {
          size
          interval
        }
        sign
        name
        distance
        time
        exit_number
        turn_angle
      }
      stationsAlongRoute {
        id
        location {
          type
          coordinates
        }
        speed
        status
        preferredOperator
        distance
      }
      tags
    }
    alternatives {
      id
      type
      charges
      chargesAvailable
      chargesOccupied
      chargesUnknown
      chargesOutOfOrder
      distance
      duration
      consumption
      chargeTime
      rangeStart
      rangeStartKwh
      rangeStartPercentage
      rangeEnd
      rangeEndKwh
      rangeEndPercentage
      via
      polyline
      pathPlot {
        elevation
        averageSpeed
        consumption
        consumptionPerKm
        distance
        duration
        stateOfCharge
      }
      elevationUp
      elevationDown
      elevationMax
      saving {
        co2
        money
        currency
        averageGasPrice
        averageEnergyPrice
      }
      legs {
        id
        distance
        duration
        consumption
        rangeStart
        rangeStartKwh
        rangeStartPercentage
        rangeEnd
        rangeEndKwh
        rangeEndPercentage
        origin {
          id
          type
          geometry {
            type
            coordinates
          }
          properties
        }
        destination {
          id
          type
          geometry {
            type
            coordinates
          }
          properties
        }
        type
        name
        stationId
        operatorId
        operatorName
        operatorRanking
        chargeTime
        evse {
          uid
          evse_id
          status
          status_schedule {
            period_begin
            period_end
            status
          }
          capabilities
          connectors {
            id
            standard
            format
            power_type
            max_voltage
            max_amperage
            max_electric_power
            power
            tariff_ids
            terms_and_conditions
            last_updated
            properties
            tariff {
              country_code
              party_id
              id
              currency
              type
              tariff_alt_text {
                language
                text
              }
              tariff_alt_url
              min_price {
                excl_vat
                incl_vat
              }
              max_price {
                excl_vat
                incl_vat
              }
              elements {
                price_components {
                  type
                  price
                  vat
                  step_size
                }
                restrictions {
                  start_time
                  end_time
                  start_date
                  end_date
                  min_kwh
                  max_kwh
                  min_current
                  max_current
                  min_power
                  max_power
                  min_duration
                  max_duration
                  day_of_week
                  reservation
                }
              }
              start_date_time
              end_date_time
              energy_mix {
                is_green_energy
                energy_sources {
                  source
                  percentage
                }
                environ_impact {
                  category
                  amount
                }
                supplier_name
                energy_product_name
              }
              last_updated
            }
            prices {
              external_id
              partner
              partner_id
              product {
                name
                type
                description
                subscription_type
                subscription_fee_excl_vat
                currency
              }
              elements {
                components {
                  type
                  price_excl_vat
                  vat
                  step_size
                }
                restrictions {
                  start_time
                  end_time
                  start_date
                  end_date
                  minimum_kwh
                  maximum_kwh
                  minimum_power
                  maximum_power
                  minimum_current
                  maximum_current
                  minimum_price
                  maximum_price
                  overstay_battery_percentage {
                    minimum
                    maximum
                    unit
                  }
                  overstay_time {
                    minimum
                    maximum
                    unit
                  }
                  minimum_duration
                  maximum_duration
                  day_of_week
                  emsp_contract_date {
                    name
                    from
                    to
                  }
                  reservation
                }
              }
              last_updated
            }
            custom_properties {
              oicp {
                dynamic_power_level
                charging_modes
              }
            }
          }
          floor_level
          coordinates {
            latitude
            longitude
          }
          physical_reference
          parking_restrictions
          images {
            url
            thumbnail
            category
            type
            width
            height
          }
          last_updated
          parking_cost
          cpo_external_id
          properties
          custom_properties {
            oicp {
              authentication_modes
              max_capacity
              payment_options
              value_added_services
              additional_info {
                lang
                value
              }
              is_hubject_compatible
              hardware_manufacturer
            }
          }
        }
        connector {
          id
          standard
          format
          power_type
          max_voltage
          max_amperage
          max_electric_power
          power
          tariff_ids
          terms_and_conditions
          last_updated
          properties
          tariff {
            country_code
            party_id
            id
            currency
            type
            tariff_alt_text {
              language
              text
            }
            tariff_alt_url
            min_price {
              excl_vat
              incl_vat
            }
            max_price {
              excl_vat
              incl_vat
            }
            elements {
              price_components {
                type
                price
                vat
                step_size
              }
              restrictions {
                start_time
                end_time
                start_date
                end_date
                min_kwh
                max_kwh
                min_current
                max_current
                min_power
                max_power
                min_duration
                max_duration
                day_of_week
                reservation
              }
            }
            start_date_time
            end_date_time
            energy_mix {
              is_green_energy
              energy_sources {
                source
                percentage
              }
              environ_impact {
                category
                amount
              }
              supplier_name
              energy_product_name
            }
            last_updated
          }
          prices {
            external_id
            partner
            partner_id
            product {
              name
              type
              description
              subscription_type
              subscription_fee_excl_vat
              currency
            }
            elements {
              components {
                type
                price_excl_vat
                vat
                step_size
              }
              restrictions {
                start_time
                end_time
                start_date
                end_date
                minimum_kwh
                maximum_kwh
                minimum_power
                maximum_power
                minimum_current
                maximum_current
                minimum_price
                maximum_price
                overstay_battery_percentage {
                  minimum
                  maximum
                  unit
                }
                overstay_time {
                  minimum
                  maximum
                  unit
                }
                minimum_duration
                maximum_duration
                day_of_week
                emsp_contract_date {
                  name
                  from
                  to
                }
                reservation
              }
            }
            last_updated
          }
          custom_properties {
            oicp {
              dynamic_power_level
              charging_modes
            }
          }
        }
        plugsAvailable
        plugsOccupied
        plugsUnknown
        plugsOutOfOrder
        plugsCount
        polyline
        steps {
          id
          type
          polyline
          distance
          duration
          consumption
        }
        tags
        cargo
        occupants
      }
      instructions {
        points {
          size
          interval
        }
        sign
        name
        distance
        time
        exit_number
        turn_angle
      }
      stationsAlongRoute {
        id
        location {
          type
          coordinates
        }
        speed
        status
        preferredOperator
        distance
      }
      tags
    }
    ev {
      id
      battery {
        capacity {
          value
          type
        }
        capacityKwh
        stateOfCharge {
          value
          type
        }
        stateOfChargeKwh
        finalStateOfCharge {
          value
          type
        }
        finalStateOfChargeKwh
      }
      plugs {
        standard
        chargingPower
      }
      adapters {
        standard
        chargingPower
      }
      minPower
      climate
      heatPump
      cabin {
        isPreconditioned
        desiredTemperature
      }
      cargo
      occupants
      consumption {
        auxiliary
      }
    }
    telemetry
    routeRequest {
      amenity_preferences {
        all_charge_stops
        scheduled_charge_stops {
          types
          duration
          offset
          stop_after
          max_distance_from_station
        }
      }
      operators {
        type
        ranking {
          level1
          level2
          level3
          level4
          level5
          level6
          level7
          level8
          level9
          level10
        }
        exclude
      }
      season
      safeRiskMargin
      origin {
        id
        type
        geometry {
          type
          coordinates
        }
        properties
      }
      destination {
        id
        type
        geometry {
          type
          coordinates
        }
        properties
      }
      via {
        id
        type
        geometry {
          type
          coordinates
        }
        properties
      }
      stationsAlongRouteRadius
      chargeMode
    }
    app {
      id
    }
    status
  }
}

Besoin d'aide ? Contacter le support.

Itinéraire

Détails de l’itinéraire

Opérations

Changements généraux du schéma

Changements de requête et de souscription

Niveau supérieur

Itinéraire

Tronçons

Changements mis en avant

Sections

Arguments

Champs

Erreurs

Gérer les cookies

Politique relative aux cookies

Vérifier vos choix de consentement aux cookies

Cookies essentiels

Cookies de performance

Cookies marketing / publicitaires

Engagement envers les tiers

Comment contrôler ou refuser les cookies