Gestion de la flotte | Les Webservices Océan

Récupérer les entités d’un client

get /restapi/mobility/v1/entities

Documentation supplémentaire sur SWAGGER

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Aucun paramètre de requête requis

Réponses

200 OK

application/json;charset=utf-8

[ {

entities	integer ($int64) Identifiant de l’entité
Nom	string Nom de l’entité

} ]

Récupérer les données des véhicules

get /restapi/vehicule_engin/vehicles

Documentation supplémentaire sur SWAGGER

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom	Description
immatriculation	string Immatriculation du véhicule
includeFields	array Array of string Champs à inclure (cf. Facebook Graph API)

Réponses

200 OK

application/json;charset=utf-8

[ {

boitier {	object
adBoi	string (50) Ad du boitier (APC pour BBOXv1 obsolète)
commentaireBoi	string Le commentaire du boitier
coreGsmBoi	string Numéro GSM du boitier
debutGarantie	string Début de la garantie du boitier
finGarantie	string Fin de garantie du boitier
id	integer ($int32) Identifiant du boitier
idEtatBoitier	integer ($int32) Identifiant de l’état du boitier
imeiBoi	string (15) Imei du boitier
numeroSerieBoi	string (50) Numéro de série du boitier
sn	string (30) SN (Serial Number) du boitier
}
chauffeur {	object
email	string (50) Email du chauffeur
gsm	string (20) Téléphone du chauffeur
id	integer ($int64) Identifiant du boitier
nomInd	string (100) Nom du chauffeur
prenomInd	string (100) Prénom du chauffeur
suppressionLogique	boolean Suppression en base de données (oui/non)
}
emissionCo2	integer ($int64) Taux émission de CO2
entite {	object
id	integer ($int64) Identifiant de l’entité
nom	string (150) Nom de l’entité
suppressionLogique	boolean Suppression en base de données (oui/non)
}
releve {	object
dateReleve	string Date du relevé de compteur kilométrique
id	integer ($int64) Suppression en base de données (oui/non)
value	integer ($int64) Valeur du relevé de compteur kilométrique à la fin de la journée précédente (valeur calculée à minuit)
}
releveAjuste {	object
dateReleve	string Date du relevé de compteur kilométrique
id	integer ($int64) Supression en base de données (oui/non)
value	integer ($int64) Valeur du relevé de compteur kilométrique sur la dernière position reçue
}
vehicle {	object
categorie	string Catégorie du véhicule
couleur	string (50) Couleur du véhicule
description	string (100) Description du véhicule
dioEnabled	boolean Donnée sur une entrée/sortie dans le boitier oui/non (moteur auxiliaire, ...)
dispositifIdentifiant	boolean Etat du dispositif identifiant (oui/non)
geosecuriteEnabled	boolean Activation de géosecurité (oui/non)
id	integer ($int32) Identifiant du véhicule
immatriculation	string (50) Immatriculation du véhicule
marque	string (50) Marque du véhicule
modele	string (50) Modèle du véhicule
nomImage	string Nom de l’image du véhicule
numeroEmbarque	integer ($int32) Numéro embarqué du véhicule
numeroSerie	string Numéro de série du véhicule
odirectMode	string Mode O-Direct Renault/Peugeot/Kuantic, …
privacyEnabled	boolean Mode « Vie Privée » activé
suppressionLogique	boolean Suppression en base de données (oui/non)
}
visites [ {	object
compteurPrevu	integer ($int64) Compteur de la prochaine visite
datePrevue	string Date de la prochaine visite
description	string (100) Description de la prochaine visite
idVisiteEntretien	integer ($int64) Identifiant de la prochaine visite
} ]

} ]

401 Unauthorized

application/json;charset=utf-8

403 Forbidden

application/json;charset=utf-8

404 Not Found

application/json;charset=utf-8

Récupérer les contrats de location des véhicules

get /restapi/contrat_location/contrats

Documentation supplémentaire sur SWAGGER

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom	Description
customerId obligatoire	integer ($int64) Identifiant du client
date	string Filtre sur les contrats actifs à cette date. La date doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API
vehicleIds	array (of int) Filtre sur les véhicules identifiés (nombre illimité)

Réponses

200 OK

application/json;charset=utf-8

[ {

id	integer ($int64) identifiant du contrat
loueur	string nom du loueur
nbKmPrevus	integer ($int64) nombre de kilomètres prévus dans le contrat
nbMoisPrevus	integer ($int64) durée prévue du contrat en mois
nbMoisUtilisation	integer ($int64) nombre de mois écoulés du contrat
typeLocation	string Type de la location (leasing, achat, inconnu...)
vehicleId	integer ($int64) identifiant du véhicule rattaché au contrat

} ]

401 Unauthorized

application/json;charset=utf-8

403 Forbidden

application/json;charset=utf-8

404 Not Found

application/json;charset=utf-8

Récupérer les derniers événements

get /restapi/evenement/lastEvent

Documentation supplémentaire sur SWAGGER

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom	Description
customerId obligatoire	integer ($int64) Identifiant du client
vehiculesIds	array (of int) Identifiant du véhicule
entitiesIds	array (of int) Identifiant de l’entité
dateDebut	string La date de début doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API.
dateFin	string La date de fin doit être au format UTC : "dd/MM/yyyy HH:mm:ss Z". Seul ce format est pris en compte par notre API.
codeEvenements	array (of int) Identifiant de l’événement

Réponses

200 OK

application/json;charset=utf-8

{

additionalProp1 {	object
Id	integer ($int64) Identifiant du matériel
evenementLibelle	string Libellé de l’événement
groupingPeriod	string Période : TODAY, YESTERDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY, LASTWEEK, TWOWEEKS_AGO, THREEWEEKS_AGO, FOURWEEKS_AGO, FIVEWEEKS_AGO, LAST_MONTH, BEFORE_LAST_MONTH
vehicleEngin {	object
id	integer ($int64) Identifiant du véhicule
categorie	string - Enum Catégorie du véhicule / engin : UNDEFINED, VL, ALL, VUL, VU, PL, PELLE, TRCTP, COMPR, GROUP, MINIPE, CHELEVT, CHELEVE, FINISS, CHARGE, FOREUSE, CONT, BENNE, REMORQUE, AUTRE_MATERIEL, AUTRE_ENGIN, AUTRE_VEHICULE
description	string (100) Description du véhicule
geosecuriteEnabled	boolean Activation de géosecurité (oui/non)
suppressionLogique	boolean Suppression en base de données (oui/non)
dispositifIdentifiant	boolean Etat du dispositif identifiant (oui/non)
privacyEnabled	boolean Mode « Vie Privée » activé
dioEnabled	boolean Donnée sur une entrée/sortie dans le boitier oui/non (moteur auxiliaire, ...)
nomImage	string Nom de l’image du véhicule
odirectMode	string Mode O-Direct Renault/Peugeot/Kuantic …
}
entite {	object
id	integer ($int64) Identifiant de l’entité
nom	string (150) Nom de l’entité
suppressionLogique	boolean Suppression en base de données (oui/non)
}
adress {	object
address	string (150) Adresse de la position
town	string (100) Ville de la position
country	string (100) Pays de la position
postCode	string (20) Code postal de la position
countryCode	string Code postal de la position
closestPoi	string (150) Adresse de référence la plus proche
Precision	integer ($int64) Valeur de la précision de l’adresse de référence la plus proche GPS calé : true/false
latitudeY	number Position latitude X
longitudeX	string Position longitude X
cap	number Cap position GPS
}
TypeEVenement	string - Enum ENUM : DEMARRAGE, ARRET, BADGEAGE_CHAUFFEUR…
typeEvenementODirectDTO {	objectRef
eventState	string PUNCTUAL, OPEN, CLOSED
dateDebut	string Date de début
dateFin	string Date de fin
extendedDataMap {	object
ndid	string Numéro du badge
unit	string Unité de l’extended Data (donnée supplémentaire à l’événement)
anomalieId	integer ($int64) Identifiant de l’anomalie
zone	string Zone
forced	integer ($int64) Forcer 0/1
tank_level_before	integer ($int64) Niveau du réservoir avant prise de carburant
poiId	integer ($int64) Identifiant de l’adresse de référence
speed	integer ($int64) Vitesse
tank_level_after	integer ($int64) Niveau du réservoir après prise de carburant
}
heure	timestamp Heure
date	timestamp Date
}

}

401 Unauthorized

application/json;charset=utf-8

403 Forbidden

application/json;charset=utf-8

404 Not Found

application/json;charset=utf-8

Récupérer les données des matériels

get /restapi/materiel/list

Documentation supplémentaire sur SWAGGER

Authentification préalable nécessaire et passage du token dans le header X-AUTH-TOKEN

Attention : le token n’est valable que 12 heures. Au-delà de ce délai, il faudra en générer un nouveau.

Paramètres de la requête

Nom	Description
materielIds	array (of int) Liste des identifiants des matériels (nombre illimité)

Réponses

200 OK

application/json;charset=utf-8

[ {

materiel {	object
boxLightDTO {	object
id	integer ($int64) Identifiant du boitier
numeroSerieBoi	string (50) Numéro de série du boitier
}
entiteLightDTO {	object
id	integer ($int64) Identifiant de l’entité
nom	string (150) Nom de l’entité
suppressionLogique	boolean Suppression en base de données (oui/non)
}
materiel {	object
description	string (100) Description du matériel
id	integer ($int64) Identifiant du matériel
marque	string (50) Marque du matériel
modele	string (50) Modèle du matériel
reference	string (50) Référence du matériel
}
proprietesSpecifiquesDTO {	object
id	integer ($int64) Identifiant de la propriété
idObjetRef	integer ($int64) Identifiant de l’objet de référence
typeObjet	string Type d’objet de référence (Véhicules, matériel)
}
trameDTO {	object
id	integer ($int64) Identifiant de la trame
reason	string Code interne type d’ événement
scenarioDTO {	object
code	string Code du scénario
i18nKey	string Libellé du scénario
id	integer ($int64) Identifiant du scénario du boitier
}
stateBoitier	boolean Adresse de la position
}
}

} ]