- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Fenêtre d'affichage
Affiche une liste paginée des véhicules associés à un fournisseur qui correspondent aux options de la requête.
Requête HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
parent |
Obligatoire. Doit se présenter sous la forme |
Paramètres de requête
Paramètres | |
---|---|
header |
En-tête de requête Fleet Engine standard. |
page |
Nombre maximal de véhicules à renvoyer. La valeur par défaut est 100. |
page |
Valeur de l' |
minimum |
Spécifie la capacité minimale requise du véhicule. La valeur |
trip |
Limite la réponse aux véhicules compatibles avec au moins un des types de trajets spécifiés. |
maximum |
Limite la réponse aux véhicules qui ont envoyé des mises à jour de position à Fleet Engine au cours de la durée spécifiée. Les véhicules fixes qui transmettent encore leur position ne sont pas considérés comme obsolètes. Si présent, doit être une durée positive valide. Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par " |
vehicle |
Obligatoire. Limite la réponse aux véhicules appartenant à l'une des catégories de type spécifiées. |
required |
Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs
Limite la réponse aux véhicules présentant les attributs spécifiés. Ce champ est une opération de conjonction/opération AND. Un maximum de 50 attributs requiredAttributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé pour un véhicule. Chaque chaîne répétée doit être au format "clé:valeur". |
required |
Limite la réponse aux véhicules présentant au moins l'un des attributs spécifiés dans chaque |
required |
Tout comme
Limite la réponse aux véhicules qui correspondent à tous les attributs d'un |
vehicle |
Limite la réponse aux véhicules dont l'état est défini. |
on |
Ne renvoyez que les véhicules avec le ou les trajets actuels. |
filter |
Facultatif. Requête de filtre à appliquer lors de la liste des véhicules. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre. Ce champ est conçu pour remplacer les champs Ce filtre fonctionne comme une clause ET avec d'autres contraintes, telles que Notez que les seules requêtes acceptées concernent les attributs du véhicule (par exemple, De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons acceptées par rapport aux attributs sont les comparaisons de chaînes. Pour effectuer une comparaison avec des valeurs numériques ou booléennes, les valeurs doivent être explicitement placées entre guillemets pour être traitées comme des chaînes (par exemple, |
viewport |
Facultatif. Filtre qui limite les véhicules renvoyés à ceux dont la dernière position connue se trouvait dans la zone rectangulaire définie par la fenêtre d'affichage. |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Message de réponse vehicles.list
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"vehicles": [
{
object ( |
Champs | |
---|---|
vehicles[] |
Véhicules correspondant aux critères de la requête. Le nombre maximal de véhicules renvoyés est déterminé par le champ |
next |
Jeton permettant de récupérer la page suivante des véhicules, ou vide si aucun véhicule ne répond plus aux critères de la requête. |
total |
Obligatoire. Nombre total de véhicules correspondant aux critères de la demande sur toutes les pages. |
Fenêtre d'affichage
Fenêtre d'affichage de latitude-longitude, représentée par deux points low
et high
opposés en diagonale. Une fenêtre d'affichage est considérée comme une région fermée, c'est-à-dire qu'elle inclut sa limite. Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude entre -180 et 180 degrés inclus. Voici quelques exemples :
Si
low
=high
, la fenêtre d'affichage ne comprend qu'un seul point.Si
low.longitude
>high.longitude
, la plage de longitude est inversée (la fenêtre d'affichage croise la ligne de longitude de 180 degrés).Si
low.longitude
= -180 degrés ethigh.longitude
= 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.Si
low.longitude
= 180 degrés ethigh.longitude
= -180 degrés, la plage de longitudes est vide.Si
low.latitude
>high.latitude
, la plage de latitude est vide.
low
et high
doivent être renseignés, et la zone représentée ne doit pas être vide (comme indiqué dans les définitions ci-dessus). Un viewport vide entraînera une erreur.
Par exemple, ce viewport englobe entièrement la ville de New York :
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Représentation JSON |
---|
{ "low": { object ( |
Champs | |
---|---|
low |
Obligatoire. Point bas de la fenêtre d'affichage. |
high |
Obligatoire. Point le plus élevé de la fenêtre d'affichage. |