Modifier un document de voyage

  • Customers
  • Compte client
  • 3 routes
Comment modifier un document de voyage pour un client ?

Ce scénario permet à un client de modifier son document de voyage quel qu'en soit le type.

Vue d'ensemble

Utilisez ce scénario pour relire le contexte client, consulter les règles légales utiles, puis mettre à jour un document de voyage sur le même compte. Ce parcours sécurise la modification en vérifiant d'abord que le bon client et le bon document sont ciblés.

Prérequis

  • Disposer d'un customer_id valide.
  • Fournir authorization, x-api-key et accept-language sur les routes en scope client.
  • Préparer les données documentaires à corriger avant l'appel de mise à jour.

Process workflow

Legend:
Obligatoire
Optionnel
1

Récupérer les informations d'un client

Obligatoire

Utilisez GET/v0/customers/{customer_id} pour confirmer le contexte du compte client avant de modifier un document de voyage.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.clubmed.com/v0/customers/{customer_id}"

Example answer

{
  "id": "customer-1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane@example.com"
}

info: Réutilisez les données d'identité retournées pour vérifier que le bon client est ciblé avant de lire ou modifier ses documents.


Codes de réponse

  • 200 OK : les données attendues sont renvoyées.
  • 400 Bad Request : la requête est invalide ou incomplète.
  • 401 Unauthorized : le token est manquant ou invalide.
  • 403 Forbidden : l'accès est refusé dans ce contexte.
  • 404 Not Found : la ressource demandée est introuvable.
GET/v0/customers/{customer_id}
Voir plus
2

Consulter les informations légales

Obligatoire

Utilisez GET/v0/legal_info pour récupérer les contraintes légales susceptibles d'impacter les données documentaires que vous allez maintenir.

Prérequis

Préparez les paramètres utiles à l'appel. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  "https://api.clubmed.com/v0/legal_info"

Example answer

{
  "terms_url": "https://example.com/terms",
  "privacy_url": "https://example.com/privacy"
}

info: Consultez d'abord les contraintes légales pour valider les champs documentaires obligatoires dans le bon contexte marché.


Codes de réponse

  • 200 OK : les données attendues sont renvoyées.
  • 400 Bad Request : la requête est invalide ou incomplète.
  • 404 Not Found : la ressource demandée est introuvable.
GET/v0/legal_info
Voir plus
3

Modifier un document de voyage

Obligatoire

Utilisez PATCH/v1/customers/{customer_id}/travel_documents pour modifier un document de voyage.

Prérequis

Préparez customer_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide. Vérifiez le body avant appel pour éviter une erreur de validation.

Calling CURL

curl -X PATCH \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documents": [{"id": "doc-1", "number": "XX123456", "expiration_date": "2030-07-01"}]}' \
  "https://api.clubmed.com/v1/customers/{customer_id}/travel_documents"

Example answer

HTTP/1.1 204 No Content

info: Le succès peut être renvoyé sans body. Relisez la ressource ensuite si vous devez afficher l'état final.


Codes de réponse

  • 204 No Content : l'opération est appliquée avec succès.
  • 400 Bad Request : le body ou les paramètres sont invalides.
  • 401 Unauthorized : le token est manquant ou invalide.
  • 403 Forbidden : l'accès est refusé dans ce contexte.
  • 404 Not Found : la ressource ciblée est introuvable.
PATCH/v1/customers/{customer_id}/travel_documents
Voir plus