Importez des demandes CEE existantes par lot

POST /policies/cee/import

Envoi par chaque opérateur concerné de l'historique des bénéficiaires d'opérations spécifiques sur les 3 années précédents 2023. Pour chaque bénéficiaire les informations suivantes sont requises : phone_trunc, last_name_trunc, datetime et journey_type.

Afin que l'API soit fonctionnelle, les opérateurs doivent faire remonter l'historique au RPC au plus tôt.

application/json

Body Required

journey_type string Required

Values are short or long.
phone_trunc string Required

Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres

Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
last_name_trunc string Required

Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "

Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
datetime string(datetime) Required

Date d'engagement de l'opération concernée.

Responses

201 application/json

OK
Hide response attributes Show response attributes object
- imported number Required
  
  Nombre de demandes importées avec succès
  
  Minimum value is 0, maximum value is 1000.
- failed number Required
  
  Nombre de demandes non importées
  
  Minimum value is 0, maximum value is 1000.
- failed_details array[object] Required
  
  At least 0 but not more than 1000 elements.
  
  Hide failed_details attributes Show failed_details attributes object
  
  journey_type string Required
  
  Values are short or long.
  
  phone_trunc string Required
  
  Numéro de téléphone au format ITU-T E.164 tronqué des 2 derniers chiffres
  
  Minimum length is 10, maximum length is 14. Format should match the following pattern: ^\+[0-9]{8,12}$.
  
  last_name_trunc string Required
  
  Correspond aux trois premièrs caractères du nom de famille complet en majuscule, sans accent ni tiret ni apostrophe. Dans le cas où le nom comporterait moins de 3 lettres, compléter avec des espaces. Ex 1: M. D'Hérûg-de-l'Hérault => "D H" Ex 2: M. Tô => "TO "
  
  Minimum length is 3, maximum length is 3. Format should match the following pattern: ^[A-Z ]{3}$.
  
  datetime string(datetime) Required
  
  Date d'engagement de l'opération concernée.
  
  error string Required
401 application/json

Non authentifié. Le token applicatif est manquant ou invalide.
403 application/json

Non autorisé

POST /policies/cee/import

curl \
 -X POST https://api.demo.covoiturage.beta.gouv.fr/v3.1/policies/cee/import \
 -H "Content-Type: application/json" \
 -d '[{"journey_type":"short","phone_trunc":"+336010203","last_name_trunc":"string","datetime":"string"}]'

Request examples

[
  {
    "journey_type": "short",
    "phone_trunc": "+336010203",
    "last_name_trunc": "string",
    "datetime": "string"
  }
]

Response examples (201)

{
  "imported": 42.0,
  "failed": 42.0,
  "failed_details": [
    {
      "journey_type": "short",
      "phone_trunc": "+336010203",
      "last_name_trunc": "string",
      "datetime": "string",
      "error": "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"
}