Documents de voyage

  • Docs booking
  • 2 routes
Comment consulter et mettre à jour les documents de voyage d'un client ?

Ce scénario explique comment récupérer les documents de voyage rattachés à un profil client puis les mettre à jour lorsqu'une information doit être corrigée ou complétée. Il convient aux parcours selfcare, service client et préparation de réservation.

Le flux relit d'abord le jeu de documents courant, puis met à jour le dossier client avec le payload de documents corrigé.

Vue d'ensemble

Ce scénario aide une application à afficher et à maintenir les documents légaux de voyage rattachés à un compte client.

Prérequis

  • Un customer_id valide.
  • Un contexte d'authentification customer-scoped avec authorization, accept-language et x-api-key.
  • Les informations documentaires à corriger ou compléter.

Résultat attendu

L'application peut afficher les documents courants, soumettre les corrections nécessaires et garder le profil client aligné avec les contraintes du parcours de réservation.

Process workflow

Legend:
Obligatoire
Optionnel
1

Recuperer les documents de voyage du client

Obligatoire

Utilisez GET/v1/customers/{customer_id}/travel_documents pour recuperer les documents de voyage actuellement stockes pour un client avant un controle de conformite, une finalisation de parcours ou un flux d'emission transport.

Prerequis

  • Reutiliser un customer_id valide.
  • Envoyer accept-language, authorization et x-api-key.
  • Verifier que le contexte authentifie peut acceder a ce client.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v1/customers/123456789/travel_documents' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "passport": {
    "document_number": "09PR5121E",
    "issuing_country": "FR",
    "nationality": "FR",
    "expiration_date": "20100430"
  },
  "id_card": {
    "document_number": "09PR5121E",
    "issuing_country": "FR",
    "expiration_date": "20100430"
  },
  "visas": [
    {
      "document_number": "09PR5121E",
      "category": "FR",
      "expiration_date": "20100430"
    }
  ],
  "travel_membership_cards": [
    {
      "company_code": "AF",
      "company_label": "AIR FRANCE",
      "number": "2060444771",
      "status": "GOLD"
    }
  ]
}

info: Cette route retourne l'inventaire legal et documentaire actuel, pratique pour identifier ce qu'il reste a completer avant une emission transport.

Codes de reponse

  • OK Response (200): retourne les documents de voyage actuellement stockes pour le client.
  • Error (400): un parametre obligatoire est manquant ou invalide.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (403): les regles de locale ou d'issuer empechent l'acces a ces documents.
  • Error (404): non documente dans le Swagger.
GET/v1/customers/{customer_id}/travel_documents
Voir plus
2

Mettre a jour les documents de voyage du client

Obligatoire

Utilisez PATCH/v1/customers/{customer_id}/travel_documents pour modifier les informations de documents de voyage deja rattachees au profil client lorsqu'un document doit etre corrige, renouvele ou complete.

Prerequis

  • Reutiliser un customer_id valide.
  • Envoyer accept-language, authorization et x-api-key.
  • Preparer un body JSON Patch aligne avec le document a modifier.

Calling CURL

curl -X 'PATCH' \
  'https://api.clubmed.com/v1/customers/123456789/travel_documents' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '[ ... ]'

Example answer

{
  "passport": {
    "document_number": "09PR5121E",
    "issuing_country": "FR",
    "expiration_date": "20100430"
  },
  "id_card": {
    "document_number": "09PR5121E",
    "issuing_country": "FR",
    "expiration_date": "20100430"
  },
  "travel_membership_cards": [
    {
      "company_code": "AF",
      "company_label": "AIR FRANCE",
      "number": "2060444771",
      "status": "GOLD"
    }
  ]
}

info: La route implemente JSON Patch ; le body doit donc decrire precisement les operations a appliquer sur l'inventaire documentaire courant.

Codes de reponse

  • OK Response (200): retourne l'inventaire documentaire mis a jour apres le patch.
  • Error (400): le payload JSON Patch est invalide ou incomplet.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (403): les regles de locale ou d'issuer empechent la mise a jour.
  • Error (404): non documente dans le Swagger.
PATCH/v1/customers/{customer_id}/travel_documents
Voir plus