Les Webservices Océan

Gestion des missions

Cette API permet de :

  • Créer une nouvelle mission,
  • Modifier une mission en cours,
  • Retrouver le statut d’une mission,
  • Supprimer une mission.

Cette fonctionnalité n’est disponible que pour les clients ayant souscrit aux web services en complément d’une solution GéoPack ou GéoPro.

Créer une nouvelle mission

post /restapi/geomission/ajoutMission

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
idMission string

Identifiant client de la mission

jourHeureInter string ($dateTime)

Date d'intervention, elle doit être au format UTC : "dd/MM/yyyy HH:mm". Seul ce format est pris en compte par notre API.

jourHeurePeremp string ($dateTime)

Date de suppression automatique de la mission sur l’écran, elle doit être au format UTC : "dd/MM/yyyyHH:mm". Seul ce format est pris en compte par notre API.

typeMission string

Type de la mission

nomVeh string

Nom du véhicule

nomIndi string

Nom de l'individu (si aucun véhicule sélectionné, le destinataire cible est un individu avec nom prénom)

prenomIndi string

Prénom de l'individu (si aucun véhicule sélectionné, le destinataire cible est un individu avec nom prénom)

nomPrenom string

Nom et prénom de l'individu

commentaire string

Commentaire de la mission

adrRefCli string

Nom de l’adresse de référence client (tronquée à 20 caractères sur l’affichage site et écran)

rue string

Rue de destination

codPost string

Code postal de destination

ville string

Ville de destination

aEnvoyer boolean

TRUE si la mission est à envoyer
FALSE si la mission est seulement préparée

longitude number ($double)

Longitude de la destination

latitude number ($double)

Latitude de la destination

Modifier une mission en cours

post /restapi/geomission/modifierMission

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
idMission string

Identifiant client de la mission

jourHeureInter string ($dateTime)

Date d'intervention, elle doit être au format UTC : "dd/MM/yyyy HH:mm". Seul ce format est pris en compte par notre API.

jourHeurePeremp string ($dateTime)

Date de suppression automatique de la mission sur l’écran, elle doit être au format UTC : "dd/MM/yyyyHH:mm". Seul ce format est pris en compte par notre API.

typeMission string

Type de la mission

nomVeh string

Nom du véhicule

nomIndi string

Nom de l'individu (si aucun véhicule sélectionné, le destinataire cible est un individu avec nom prénom)

prenomIndi string

Prénom de l'individu (si aucun véhicule sélectionné, le destinataire cible est un individu avec nom prénom)

nomPrenom string

Nom et prénom de l'individu

commentaire string

Commentaire de la mission

adrRefCli string

Nom de l’adresse de référence client (tronquée à 20 caractères sur l’affichage site et écran)

rue string

Rue de destination

codPost string

Code postal de destination

ville string

Ville de destination

aEnvoyer boolean

TRUE si la mission est à envoyer
FALSE si la mission est seulement préparée

longitude number ($double)

Longitude de la destination

latitude number ($double)

Latitude de la destination

Retrouver le statut d’une mission

get /restapi/geomission/statutMission

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
idMission obligatoire string

Identifiant client de la mission

Réponses

Supprimer une mission

post /restapi/geomission/supprimerMission

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
idMission obligatoire string

Identifiant client de la mission