Documentation technique

Accueil / Documentation technique / Flux v2 / API d’écriture / v002/autorisation/objet-touristique/modification/

v002/autorisation/objet-touristique/modification/

Cette méthode permet de tester avant l’écriture d’une offre si la modification sur l’offre touristique sera possible. Apidae vérifie que le projet d’écriture ou l’utilisateur dispose des droits nécessaires et qu’il n’y a pas de brouillon verrouillé par un autre utilisateur.

Cette méthode propose un tokenSSO facultatif ce qui lui permet de couvrir le cas des projets d’écriture classique (sans tokenSSO) comme les projets d’écriture multi-membres avec ou sans utilisateur identifié, donc avec ou sans tokenSSO.

Point d’entrée

  • description : Détermine si l’utilisateur authentifié ou le projet peut modifier l’objet touristique désigné par {id}.
  • méthode : GET
  • url : <root>/autorisation/objet-touristique/modification/{reference_id}?tokenSSO=b71fdbc4-a2b3-4c64-b9cf-9d0447b77640
  • authentification : l’authentification est faite par OAuth (voir Authentification Client Credentials)
  • paramètres : 
    • {id} est l’identifiant numérique de l’objet touristique
    • tokenSSO est facultatif (voir Authentification SSO)
      • Si le tokenSSO est présent, la permission est déterminée par rapport à l’utilisateur identifié.
      • Si le tokenSSO est absent, la permission est déterminée à partir de l’utilisateur associé au projet en écriture.

Format de sortie

3 valeurs possibles :

  • MODIFICATION_POSSIBLE : si l’objet touristique peut actuellement être modifié par le projet d’écriture ou l’utilisateur.
  • VERROUILLE : si l’objet touristique est actuellement en cours de modification par un utilisateur différent.
  • NON_DISPONIBLE : si l’utilisateur n’est pas autorisé à réaliser de modifications sur cet objet.

Cas d’erreur

  • Erreur 404 : projet, utilisateur ou objet touristique non trouvé ; le corps de la réponse HTTP contient le message d’erreur au format texte.
  • Erreur 50x : erreur de traitement ; le corps de la réponse HTTP contient le message d’erreur au format texte.