Documentation

Activité

MéthodeRouteDescription
GET /types-activities

[Hermes Link] Retourne une liste de types d'activités
POST /activities

[Hermes Link] Retourne une liste d'activités
GET /tacho/types-activities

[Hermes Fleet Truck] Retourne une liste de types d'activités issues du tachygraphe
POST /tacho/activities

[Hermes Fleet Truck] Retourne une liste d'activités issues du tachygraphe (Conduite, Repose, ...)

Champ personnalisé

MéthodeRouteDescription
GET /custom-fields

[Hermes Link] Retourne une liste de champs personnalisés

Compétence

MéthodeRouteDescription
GET /skills

[Hermes Link] Retourne une liste de compétences
GET /skills/{uid}

[Hermes Link] Retourne une compétence
POST /skills

[Hermes Link] Créer une nouvelle compétence
PUT /skills/{uid}

[Hermes Link] Modifie une compétence
DELETE /skills/{uid}

[Hermes Link] Supprime une compétence à partir de son uid ou code
GET /skills-families

[Hermes Link] Retourne une liste de famille de compétences
GET /skills-families/{uid}

[Hermes Link] Retourne une liste de famille de compétences
POST /skills-families

[Hermes Link] Crée une nouvelle famille de compétences
PUT /skills-families/{uid}

[Hermes Link] Modifie une famille compétence
DELETE /skills-families/{uid}

[Hermes Link] Supprime une famille de compétences à partir de son uid ou code

Compte

MéthodeRouteDescription
GET /accounts

[Hermes Link] Retourne une liste de comptes
POST /accounts

[Hermes Link] Crée un nouveau compte
PUT /accounts/{uid}

[Hermes Link] Modifie un compte

Contact

MéthodeRouteDescription
POST /contacts/page

[Hermes Link] Retourne une liste de contacts
GET /contacts/{uid}

[Hermes Link] Retourne un contact
POST /contacts

[Hermes Link] Crée un nouveau contact
PUT /contacts/{uid}

[Hermes Link] Modifie un contact
DELETE /contacts/{uid}

[Hermes Link] Supprime un contact à partir de son uid ou code

Dépôt

MéthodeRouteDescription
GET /agencies

[Hermes Link] Retourne une liste de dépôts
GET /agencies/{uid}

[Hermes Link] Retourne un dépôts
POST /agencies

[Hermes Link] Crée un nouveau dépôt
PUT /agencies/{uid}

[Hermes Link] Modifie un dépôt

Developper

MéthodeRouteDescription
GET /health

Renvoie l'état de santé de l'API.

Document

MéthodeRouteDescription
POST /documents

[Hermes Link] Retourne une liste de documents

Entreprise

MéthodeRouteDescription
POST /companies/page

[Hermes Link] Retourne une liste d'entreprises
GET /companies/{uid}

[Hermes Link] Retourne une entreprise
POST /companies

[Hermes Link] Crée une nouvelle entreprise
PUT /companies/{uid}

[Hermes Link] Modifie une entreprise
DELETE /companies/{uid}

[Hermes Link] Supprime une entreprise

Fichier

MéthodeRouteDescription
GET /download/specialities/{name}

[Hermes Link] Retourne le template d'une spécialité
GET /download/{name}

[Hermes Link] Retourne un fichier

Indisponibilité

MéthodeRouteDescription
POST /unavailabilities/page

[Hermes Link] Pagination d'indisponibilités
GET /unavailabilities/{uid}

[Hermes Link] Retourne une indisponibilité
PUT /unavailabilities/{uid}

[Hermes Link] Modifie une indisponibilité
POST /unavailabilities

[Hermes Link] Crée une indisponibilité
DELETE /unavailabilities/{uid}

[Hermes Link] Supprime une indisponibilité à partir de son uid ou code
GET /types-unavailabilities

[Hermes Link] Retourne une liste de types d'indisponibilités

Intervention

MéthodeRouteDescription
POST /appointments/page

[Hermes Link] Retourne une liste d'interventions
POST /appointments/planned/page

[Hermes Link] Retourne une liste d'interventions planifiées
POST /appointments/unplanned/page

[Hermes Link] Retourne une liste d'interventions non planifiées
GET /appointments/{uid}

[Hermes Link] Retourne une intervention
DELETE /appointments/{uid}

[Hermes Link] Supprime une intervention
POST /appointments

[Hermes Link] Crée une nouvelle intervention
PUT /appointments/{uid}

[Hermes Link] Modifie une intervention
PATCH /appointments/{uid}/form

[Hermes Link] Peuple le formulaire à une tâche
PATCH /appointments/{uid}/plan

[Hermes Link] Planifie une intervention
PATCH /appointments/{uid}/unplan

[Hermes Link] Déplanifie une intervention
PATCH /appointments/{uid}/publish

[Hermes Link] Publie une intervention
PATCH /appointments/{uid}/unpublish

[Hermes Link] Annule la publication d'une intervention
GET /appointments/{uid}/files

[Hermes Link] Retourne une liste de pièces jointes d'une intervention

Maintenance

MéthodeRouteDescription
POST /maintenances/page

Retourne une liste de maintenances
GET /maintenances/{uid}

Retourne une maintenance

Outil

MéthodeRouteDescription
POST /tools/convert-code

Convertit un code en uid
POST /tools/convert-uid

Convertit un uid en code
POST /tools/itinerary

Retourne la distance et la durée d'un trajet
GET /tools/quota

Retourne le nombre d'appels restants à l'API pour la journée en cours
GET /tools/sms/quota

Retourne le nombre de SMS restants à envoyer
GET /tools/sms/conso

Retourne le nombre de SMS consommés sur une période

Planificateur

MéthodeRouteDescription
POST /scheduler/proposals

[Hermes Link] Retourne une liste de propositions de RDV

Planning

MéthodeRouteDescription
POST /planning/shipments

Création d'un shipment, ses lignes de produits et association des compétences
PUT /planning/shipments/{uid}

Modification d'un shipment, ses lignes de produits et association des compétences
DELETE /planning/shipments/{uid}

Suppression d'un shipment à partir de son identifiant

Ressource

MéthodeRouteDescription
GET /resources

Retourne une liste de ressources
GET /resources/{uid}

Retourne une ressource en fonction de son code ou de son uid

Site

MéthodeRouteDescription
POST /sites/page

Pagination de sites

GET /sites/{uid}

Retourne un site
POST /sites

Crée un nouveau site
PUT /sites/{uid}

Modifie un site
DELETE /sites/{uid}

Supprime un site

Trajet

MéthodeRouteDescription
POST /units/{uid}/trips

Retourne une liste de trajets d'un véhicule
GET /trips/{uid}

Retourne un trajet

Type de document

MéthodeRouteDescription
GET /documents-types

[Hermes Link] Retourne une liste de type de documents
GET /documents-types/{uid}

[Hermes Link] Retourne un type de document
POST /documents-types

[Hermes Link] Crée un nouveau type de document
PUT /documents-types/{uid}

[Hermes Link] Modifie un type de document
DELETE /documents-types/{uid}

[Hermes Link] Supprime un type de document à partir de son uid ou code

Utilisateur

MéthodeRouteDescription
POST /users/page

Pagination d'utilisateurs

GET /users/{uid}

Retourne un utilisateur

POST /users

Crée un nouveau utilisateur
PUT /users/{uid}

Modifie un utilisateur
POST /users/{uid}/forgot-password

Demande la réinitialisation du mot de passe d'un utilisateur
DELETE /users/{uid}

Supprime un utilisateur à partir de son uid ou code
GET /users-roles

Récupération des rôles des utilisateurs

Véhicule

MéthodeRouteDescription
GET /units

Retourne une liste de véhicules expirés ou non
GET /units/active

Retourne une liste de véhicules actifs
GET /units/expire

Retourne une liste de véhicules expirés
GET /units/{uid}

Retourne un véhicule à partir de son identifiant ou de son code
GET /units/{unitUid}/locations/page

Retourne une liste de positions d'un véhicule en partant d'une certaine position
GET /units/{uid}/locations

Retourne une liste de positions d'un véhicule
GET /units/{uid}/trips-summary

Retourne le carnet de bord d'un véhicule
GET /units/{uid}/track-info

Retourne une liste d'activité d'un véhicule