Exporter des trajets

POST /exports

Exporter des trajets en CSV

Les exports sont conservés 7 jours.

La création d'un export peut prendre plusieurs minutes. Un email est envoyé aux destinataires une fois l'export terminé.

application/json

Body Required

  • tz string Required

    Fuseau horaire

  • start_at string(date-time) Required

    Date de début au format ISO. Sélectionne les trajets >= date

  • end_at string(date-time) Required

    Date de fin au format ISO nécessairement supérieur à start_at. Sélectionne les trajets < date

  • operator_id array[number] Required

    Identifiant du ou des opérateurs à exporter

    At least 0 but not more than 128 elements.

  • recipients array[string(email)]

    Liste des adresses email des destinataires de l'export. Ces personnes recevront une notification avec un lien de téléchargement.

    At least 0 but not more than 24 elements.

  • geo_selector object

    Sélecteur géographique par découpage administratif

    Additional properties are NOT allowed.

    Hide geo_selector attributes Show geo_selector attributes object
    • arr array[string]

      Code consolidé de la zone géographique

    • com array[string]

      Code INSEE de la commune

    • epci array[string]

      Code INSEE de l'EPCI

    • aom array[string]

      SIRET de l'AOM

    • reg array[string]

      SIRET de la région

    • dep array[string]

      Code INSEE du département

Responses

  • 201 application/json

    La demande d'export a été créée. Un email sera envoyé aux destinataires avec un lien de téléchargement une fois l'export terminé.

    En cas d'erreur, la personne qui a commandé l'export sera notifiée, ainsi que l'équipe technique du RPC.

    Hide response attributes Show response attributes object
    • uuid string(uuid) Required
    • target string

      Values are operator, territory, or opendata.

    • status string

      Values are pending, running, uploading, uploaded, notify, success, or failure.

    • start_at string(date-time)
    • end_at string(date-time)
  • 401 application/json

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

  • 403 application/json

    Non autorisé

POST /exports 
curl \
 -X POST https://api.covoiturage.beta.gouv.fr/v3.1/exports \
 -H "Content-Type: application/json" \
 -d '{"tz":"Europe/Paris","start_at":"2024-01-01T00:00:00+0100","end_at":"2024-02-01T00:00:00+0100","operator_id":["[1,2,3]"],"recipients":["hello@example.com"],"geo_selector":{"aom":["200067652"]}}'
Request examples 
{
  "tz": "Europe/Paris",
  "start_at": "2024-01-01T00:00:00+0100",
  "end_at": "2024-02-01T00:00:00+0100",
  "operator_id": [
    "[1,2,3]"
  ],
  "recipients": [
    "hello@example.com"
  ],
  "geo_selector": {
    "aom": [
      "200067652"
    ]
  }
}
Response examples (201) 
{
  "uuid": "8a9d2da9-39e3-4db7-be8e-12b4d2179fda",
  "target": "operator",
  "status": "pending",
  "start_at": "2024-01-01T00:00:00+0100",
  "end_at": "2024-02-01T00:00:00+0100"
}
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"
}