Rechercher un contrat#

GET/search_contract interroge en un seul appel tous les gestionnaires de réseau que nous intégrons. Envoyez un identifiant de point de livraison, une adresse, ou les deux ; chaque opérateur concerné répond pour lui-même.

Il remplace POST/integration/enedis/search_contract, qui n'interrogeait qu'Enedis.

Paramètres#

deliveryPointId ou address est requis.

Réponse#

{
  "results": [
    {
      "deliveryPointId": "00059461297239",
      "provider": {
        "oreCode": "ENED",
        "name": "Enedis",
        "energyType": "electricity"
      },
      "address": ["1 RUE DE LA PAIX", "75001 PARIS"],
      "resOrPro": "RES",
      "name": "JEAN DUPONT",
      "confidence": 90,
      "contractId": "606b5149-1ef0-414a-8019-a050f64cc0ac"
    }
  ],
  "unresolved": [
    {
      "provider": { "oreCode": "GRDF", "name": "GRDF", "energyType": "gas" },
      "messages": [
        {
          "code": "ADDRESS_SEARCH_NOT_SUPPORTED",
          "fr": "La recherche par adresse pour le gaz n'est pas disponible. Veuillez fournir un numéro de PCE.",
          "en": "Address-based search for gas is not available. Please provide a PCE number."
        }
      ]
    }
  ]
}

results — les points de livraison. Chaque entrée porte un deliveryPointId et un provider.

unresolved — les opérateurs qui n'ont renvoyé aucun point, avec la raison. Une entrée n'a pas d'identifiant : elle décrit un opérateur, pas un point.

messages à la racine porte sur toute la réponse, pas sur un opérateur.

confidence et messages#

confidence indique à quel point une ligne répond à votre recherche, de 0 à 100. 100 est le meilleur cas : l'identifiant envoyé est confirmé et tout le reste concorde. Moins un élément envoyé concorde, et moins le point est localisé avec certitude, plus elle baisse. messages explique pourquoi elle n'est pas à 100.

Chaque message porte un code sur lequel brancher et un texte fr / en affichable tel quel.

Ce ne sont pas des erreurs#

Tous les codes ci-dessous sont renvoyés en 200 avec une réponse exploitable. Réessayer n'a d'intérêt que pour les trois codes transitoires ; tous les autres sont un constat sur les données et ne changeront pas.

Créer un Ask à partir d'un résultat : contractId#

Quand nous détenons le contrat d'un point, le résultat porte un contractId : passez-le tel quel comme élément de contracts dans POST/ask, comme l'id de la recherche Enedis existante.

Aujourd'hui seul Enedis conserve un contrat, et uniquement lorsque le titulaire a été confirmé : contractId n'est présent que si la recherche comportait un name qu'Enedis a validé. Sans contractId — GRDF, ESR, ou une recherche sans name — décrivez le contrat vous-même dans contracts : identifiant du point, titulaire et adresse, à partir du résultat et de ce que vous savez de votre client. Voir Créer un Ask.

Champs absents#

Les champs que nous ne pouvons pas remplir sont omis — jamais null, jamais de valeur de remplacement. address, name, resOrPro, messages et contractId sont optionnels sur un résultat.

Les messages disent pourquoi un champ manque. Un name absent signifie :

• HOLDER_NOT_VERIFIED — le titulaire n'a pas été vérifié. Fournissez un name.
• NAME_MISMATCH — le nom fourni n'est pas celui du titulaire.

Codes#

Absence — pas de point, et pourquoi.

Transitoire — nous n'avons pas pu demander. Réessayer peut fonctionner.

Capacité — un fait sur l'opérateur, pas sur votre recherche.

Réserves — le point est réel, quelque chose demande attention.

Capacités par opérateur#

Un nom envoyé à un opérateur qui ne peut pas le vérifier renvoie NAME_CHECK_NOT_SUPPORTED, pour qu'un nom non vérifié ne soit pas pris pour un nom confirmé.

Enedis ne communique le nom du titulaire que si vous en fournissez un qui correspond.