Invalider un trajet envoyé

POST /journeys/{operator_journey_id}/cancel
Token

Annule un trajet déjà envoyé dans le RPC.

Schema de la requête HTTP

S'il détecte un comportement inhabituel ou une fraude avérée, un opérateur doit communiquer auprès du service l'invalidation du trajet concerné dès lors qu'il est déjà inscrit dans le RPC.

Cette invalidation doit avoir lieu dès que l'opérateur a connaissance de cette irrégularité, et ce à tout moment.

Les trajets concernés seront alors associés à un statut "canceled" et n'apparaitront pas dans les données des fichiers d'export et dans l'observatoire. Ils seront en revanche comptabilisés dans les fichiers d'appel de fonds mensuel (fichiers dans lesquels sont recalculés les incitations dans le cas des campagnes suivies par le RPC sur demande de la dolletivité) si l'invalidation a été enregistrée APRES le 6 du mois suivant, date à laquelle sont générés ces fichiers.

Le code est un champ libre de 32 caractères maximum. Obligatoire.

Le message est un champ libre pour expliquer la raison de l'invalidation. Optionnel.

Path parameters

  • operator_journey_id string Required

    operator_journey_id of the journey created

    Minimum length is 1, maximum length is 256. Format should match the following pattern: ^[a-z0-9]{1,256}$.

application/json

Body Required

  • code string Required

    Format should match the following pattern: ^[0-9A-Za-z_-]{0,32}$.

  • message string

    Maximum length is 512.

Responses

  • 200

    OK La demande d'invalidation a été prise en compte

  • 401 application/json

    Non authentifié. Le token applicatif est manquant ou invalide.

  • 403 application/json

    Non autorisé

  • 404 application/json

    Le trajet n'a pas été trouvé

POST /journeys/{operator_journey_id}/cancel 
curl \
 --request POST https://api.covoiturage.beta.gouv.fr/v3.2/journeys/{operator_journey_id}/cancel \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"code":"string","message":"string"}'
Request examples 
{
  "code": "string",
  "message": "string"
}
Response examples (401) 
{
  "id": 1,
  "error": {
    "code": -32501,
    "data": "Unauthorized application",
    "message": "Unauthorized Error"
  },
  "jsonrpc": "2.0"
}
Response examples (403) 
{
  "id": 1,
  "error": {
    "code": -32503,
    "data": "Invalid permissions",
    "message": "Forbidden Error"
  },
  "jsonrpc": "2.0"
}
Response examples (404) 
{
  "code": 404,
  "error": "Not found"
}