Les Webservices Océan

Gestion des adresses de référence

Cette API permet de :

  • Créer une adresse de référence,
  • Supprimer une adresses de référence,
  • Récupérer toute la liste des adresses de référence,
  • Modifier une adresse de référence.

Modifier une adresse de référence

post /restapi/pois/updatePoi

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
poi object

Objet JSON décrivant le point d’intérêt. Pour le format de l’objet se référer à sa description dans https://v3.oceansystem.com/ocean-3.0.0/apidocs/#/poi/createPoiUsingPOST

Réponses

Créer une adresse de référence

post /restapi/pois/createPoi

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
poi obligatoire object

Objet JSON décrivant le point d’intérêt. Pour le format de l’objet se référer à sa description dans https://v3.oceansystem.com/ocean-3.0.0/apidocs/#/poi/createPoiUsingPOST

externalId string

Identifiant Externe (s’il provient d’un autre Système d’information)

source string

Source de l’identifiant externe (champs libre, ex. nom d’un logiciel pour le stockage des adresses de référence)

Réponses

Récupérer toute la liste des adresses de référence

get /restapi/pois/pois

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
searchCenterLongitudeX number ($double)

Longitude

searchCenterLatitudeY number ($double)

Latitude

searchRadius integer ($int32)

Rayon (en mètre)

externalId string

Identifiant Externe (s’il provient d’un autre Système d’information)

source string

Source de l’identifiant externe (ex. POI Fleet)

Réponses

Supprimer une adresse de référence

post /restapi/pois/deletePoi

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
idPoi obligatoire integer ($int64)

Identifiant technique de l’adresse de référence à supprimer