Mettre à jour un trajet

PATCH /journeys/{operator_journey_id}

Permet de mettre à jour un trajet qui est en erreur suite à un problème de validation sur le payload.

Path parameters

  • operator_journey_id string Required

    Identifiant unique du trajet envoyé par l'opérateur.

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

application/json

Body Required

  • operator_trip_id string

    Identifiant généré par l'opérateur pour regrouper des trajets (plusieurs passagers avec un même conducteur)

  • operator_class Required

    Classe de preuve correspondant aux spécifications définies dans Classes de preuve de covoiturage

    Values are A, B, or C.

  • incentives array[object] Required

    Tableau reprenant la liste complète des incitations appliquées (ordre d'application, montant, identifiant de l'incitateur). Si aucune incitation, envoyer un tableau vide.

    Ordre par défaut

    Par défaut, l'ordre d'application des politiques incitatives est le suivant :

    1. Territoire (AOM, Région, ...)
    2. Sponsors (incitations employeur, CE, etc.)
    3. Opérateur (opération promotionnelle, offres, etc.)
    Hide incentives attributes Show incentives attributes object
    • index number Required

      Ordre d'application de l'incitation

      Minimum value is 0.

    • amount number Required

      Montant de l'incitation en centimes d'euros

      Minimum value is 0.

    • siret string Required

      Numéro de SIRET de l'entité qui finance l'incitation. Le SIRET est un identifiant unique par structure juridique. Il est composé de 14 chiffres.

  • start object Required

    Position géographique et date de départ du passager

    Additional properties are NOT allowed.

    Hide start attributes Show start attributes object
    • datetime string(date-time) Required

      Date et heure du départ/arrivée du passager au format ISO 8601. L'heure est exprimée en UTC (YYYY-MM-DDThh:mm:ssZ)

      L'heure est exprimée en UTC (Coordinated Universal Time). UTC n'est pas ajusté sur l'heure d'été et hiver !

    • lat number Required

      Latitude comprise entre 90deg et -90deg décimaux en datum WSG-84

    • lon number Required

      Longitude comprise entre 180deg et -180deg décimaux en datum WSG-84

  • end object Required

    Position géographique et date de départ du passager

    Additional properties are NOT allowed.

    Hide end attributes Show end attributes object
    • datetime string(date-time) Required

      Date et heure du départ/arrivée du passager au format ISO 8601. L'heure est exprimée en UTC (YYYY-MM-DDThh:mm:ssZ)

      L'heure est exprimée en UTC (Coordinated Universal Time). UTC n'est pas ajusté sur l'heure d'été et hiver !

    • lat number Required

      Latitude comprise entre 90deg et -90deg décimaux en datum WSG-84

    • lon number Required

      Longitude comprise entre 180deg et -180deg décimaux en datum WSG-84

  • distance number Required

    Distance en mètres

    Minimum value is 0, maximum value is 1000000.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • operator_journey_id string Required

      Identifiant unique du trajet envoyé par l'opérateur.

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

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

  • 403 application/json

    Non autorisé

PATCH /journeys/{operator_journey_id} 
curl \
 -X PATCH https://api.demo.covoiturage.beta.gouv.fr/v3.1/journeys/{operator_journey_id} \
 -H "Content-Type: application/json" \
 -d '{"operator_trip_id":"string","operator_class":"A","incentives":[{"index":0,"amount":100,"siret":"11000101300017"}],"start":{"datetime":"2021-01-01T11:00:00Z","lat":47.682821,"lon":-0.557483},"end":{"datetime":"2021-01-01T11:00:00Z","lat":47.682821,"lon":-0.557483},"distance":42.0}'
Request examples 
{
  "operator_trip_id": "string",
  "operator_class": "A",
  "incentives": [
    {
      "index": 0,
      "amount": 100,
      "siret": "11000101300017"
    }
  ],
  "start": {
    "datetime": "2021-01-01T11:00:00Z",
    "lat": 47.682821,
    "lon": -0.557483
  },
  "end": {
    "datetime": "2021-01-01T11:00:00Z",
    "lat": 47.682821,
    "lon": -0.557483
  },
  "distance": 42.0
}
Response examples (200) 
[
  {
    "operator_journey_id": "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"
}