Aller au contenu principal
CloudStudio

Type de données Geozone

Introduction

Le type de données geozone permet d'obtenir la configuration d'une géozone. Voici toutes les propriétés du type de données geozone.

Propriétés

GeozoneID (int) La propriété GeozoneID représente l'identifiant unique de la géozone dans la plateforme. Cet identifiant est attribué automatiquement lors de la création d'une géozone. ### ClientID (int) Identifiant unique du client auquel correspond la géozone. ### Description (string) Indique la description de la géozone. ### ExternalCode (string) Indique un code externe facultatif pour la géozone. ### Polygon (object)

Contient les informations du polygone associé à la géozone. Les propriétés du polygone sont :

  • PolygonID (int) : identifiant unique du polygone.
  • Points (number[][]) : tableau de coordonnées, où chaque élément du tableau est une coordonnée avec sa latitude et sa longitude.
  • BorderColor (int) : couleur utilisée pour la bordure du polygone. Sert à l'affichage du polygone sur les cartes. Utilise un codage RVB sur 24 bits.
  • BorderWidth (int) : épaisseur de la bordure du polygone, en pixels.
  • BorderOpacity (number) : opacité de la bordure du polygone, où 1 correspond à une opacité totale et 0 à une transparence totale.
  • FillColor (int) : couleur utilisée pour le remplissage du polygone. Sert à l'affichage du polygone sur les cartes. Utilise un codage RVB sur 24 bits.
  • FillOpacity (number) : opacité du remplissage du polygone, où 1 correspond à une opacité totale et 0 à une transparence totale.

Vehicles (object array)

Contient les informations des véhicules qui se trouvent actuellement dans la géozone. Si aucun véhicule ne se trouve dans la géozone, le tableau renvoyé est vide. Pour chaque véhicule inclus dans le tableau, les données suivantes sont fournies :

  • VehicleID (int) : identifiant unique du véhicule.
  • Description (string) : description du véhicule.
  • LicensePlate (string) : numéro d'immatriculation du véhicule.

SequenceNumber (int64) Numéro de séquence associé à la géozone. Le numéro de séquence est mis à jour avec un numéro plus élevé chaque fois que la configuration de la géozone est modifiée, ainsi que lors de sa suppression. Chaque géozone créée ou modifiée reçoit obligatoirement un numéro supérieur à celui de toutes les autres géozones existantes. ### Enabled (bool) Indique si la géozone peut être utilisée ou si elle a été supprimée. La valeur false indique que la géozone a été supprimée. Les géozones supprimées ne sont accessibles que via l'API destinée à obtenir une liste de géozones de manière incrémentale.

Dernière mise à jour le

Sur cette page