Guide d'utilisation-API Données déclarative et NEBEF détaillé

Guide d’Utilisation API Tariff Version 1.3

1

GUIDE D’UTILISATION

API TARIFF

Version 1.3

Date d’entrée en vigueur : 01 Septembre 2021


2

SOMMAIRE

1 HISTORIQUE DU DOCUMENT ____________________________________ 5

2 INTRODUCTION ____________________________________________ 6

2.1 Définitions .................................................................................................... 6

2.2 Assistance technique...................................................................................... 7

3 DESCRIPTION FONCTIONNELLE DE L’API « TARIFF » ___________________ 8

3.1 Description générale ...................................................................................... 8

3.2 Pré-requis à l’utilisation des API ...................................................................... 8 3.2.1 Confidentialité des données ............................................................................. 8 3.2.2 Résiliation ..................................................................................................... 8

3.3 Ressource « /plics/eligibility » ......................................................................... 8

3.4 Ressource « /plics/state » .............................................................................. 8

3.5 Ressource « /plics/ps/historic » ...................................................................... 8

3.6 Ressource « /plics/vt/historic » ....................................................................... 9

3.7 Ressource « /ps_requests/status » .................................................................. 9

3.8 Ressource « /ps_requests/historic » ................................................................ 9

3.9 Ressource « /dpp_requests/status » ............................................................... 9

3.10 Ressource « /dpp_requests/historic » .............................................................. 9

3.11 Ressource « /vt_requests/status » .................................................................. 9

3.12 Ressource « /vt_requests/historic » ................................................................ 9

4 ACCES A L’API ___________________________________________ 10

5 RESSOURCES EXPOSEES PAR L’API « TARIFF » ______________________ 11

5.1 Ressource /plics/eligibility............................................................................. 11 5.1.1 POST /plics/eligibility .................................................................................... 11

5.1.1.1 Modalités d’appel ................................................................................ 11

5.1.1.2 Entrées .............................................................................................. 11

5.1.1.3 Sorties ............................................................................................... 12

Dans le cas où le champ status est à KO, le champ refusal_cause peut prendre l’une des valeurs suivantes : ..................................................................... 13

5.1.1.4 Règles de gestion ................................................................................ 14

5.1.1.5 Codes erreurs ..................................................................................... 14

5.2 Ressource /plics/state .................................................................................. 15 5.2.1 POST /plics/state ......................................................................................... 15


5.2.1.2 Entrées .............................................................................................. 15

5.2.1.3 Sorties ............................................................................................... 16

5.2.1.4 Codes erreurs ..................................................................................... 18

5.3 Ressource /plics/ps/historic .......................................................................... 18 5.3.1 POST /plics/ps/historic .................................................................................. 18


5.3.1.2 Entrées .............................................................................................. 18

5.3.1.3 Sorties ............................................................................................... 19


3

5.3.1.4 Codes erreurs ..................................................................................... 21

5.4 Ressource /plics/vt/historic ........................................................................... 22 5.4.1 POST /plics/vt/historic .................................................................................. 22


5.4.1.2 Entrées .............................................................................................. 22

5.4.1.3 Sorties ............................................................................................... 23

5.4.1.4 Codes erreurs ..................................................................................... 24

5.5 Ressource /ps_requests/status ..................................................................... 24 5.5.1 POST /ps_requests/status ............................................................................. 24


5.5.1.2 Entrées .............................................................................................. 25

5.5.1.3 Sorties ............................................................................................... 25

5.5.1.4 Codes erreurs ..................................................................................... 27

5.6 Ressource /ps_requests/historic .................................................................... 27 5.6.1 POST /ps_requests/historic ........................................................................... 27


5.6.1.2 Entrées .............................................................................................. 28

5.6.1.3 Sorties ............................................................................................... 29

5.6.1.4 Codes erreurs ..................................................................................... 33

5.7 Ressource /dpp_requests/status ................................................................... 33 5.7.1 POST /dpp_requests/status ........................................................................... 33


5.7.1.2 Entrées .............................................................................................. 33

5.7.1.3 Sorties ............................................................................................... 34

5.7.1.4 Codes erreurs ..................................................................................... 36

5.8 Ressource /dpp_requests/historic.................................................................. 36 5.8.1 POST /dpp_requests/historic ......................................................................... 36


5.8.1.2 Entrées .............................................................................................. 36

5.8.1.3 Sorties ............................................................................................... 37

5.8.1.4 Codes erreurs ..................................................................................... 40

5.9 Ressource /vt_requests/status ...................................................................... 40 5.9.1 POST /vt_requests/status.............................................................................. 40


5.9.1.2 Entrées .............................................................................................. 41

5.9.1.3 Sorties ............................................................................................... 41

5.9.1.4 Codes erreurs ..................................................................................... 42

5.10 Ressource /vt_requests/historic .................................................................... 43 5.10.1 POST /vt_requests/historic ............................................................................ 43

5.10.1.1 Modalités d’appel............................................................................... 43

5.10.1.2 Entrées ............................................................................................ 43

5.10.1.3 Sorties ............................................................................................. 44

5.10.1.4 Codes erreurs ................................................................................... 46

6 DETAILS DES ERREURS ______________________________________ 47


4

6.1 Erreurs fonctionnelles .................................................................................. 48 6.1.1 /plics/eligibility ............................................................................................. 48 6.1.2 /plics/state .................................................................................................. 49 6.1.3 /plics/ps/historic .......................................................................................... 49 6.1.4 /plics/vt/historic ........................................................................................... 49 6.1.5 /ps_requests/status ...................................................................................... 50 6.1.6 /ps_requests/historic .................................................................................... 50 6.1.7 /dpp_requests/status .................................................................................... 50 6.1.8 /dpp_requests/historic .................................................................................. 51 6.1.9 /vt_requests/status ...................................................................................... 51 6.1.10 /vt_requests/historic ..................................................................................... 51 6.1.11 Erreur Générique ......................................................................................... 52

6.2 Erreurs techniques ....................................................................................... 52 6.2.1 /plics/eligibility ............................................................................................. 52 6.2.2 /plics/state .................................................................................................. 52 6.2.3 /plics/ps/historic .......................................................................................... 52 6.2.4 /plics/vt/historic ........................................................................................... 52 6.2.5 /ps_requests/status ...................................................................................... 53 6.2.6 /ps_requests/historic .................................................................................... 53 6.2.7 /dpp_requests/status .................................................................................... 53 6.2.8 /dpp_requests/historic .................................................................................. 53 6.2.9 /vt_requests/status ...................................................................................... 53 6.2.10 /vt_requests/historic ..................................................................................... 54 6.2.11 Erreur Générique ......................................................................................... 54

FIN DU DOCUMENT _________________________________________ 55


5

1 Historique du document

Version Date Notes

1.0 28/09/2020 Création du Guide Utilisateur pour l’API Tariff

1.1 28/12/2020 Ajout des ressources :

POST /plics/state

POST /plics/ps/historic

POST /plics/vt/historic

POST /ps_requests/status

POST /ps_requests/historic

POST /dpp_requests/status

POST /dpp_requests/historic

POST /vt_requests/status

POST /vt_requests/historic

1.2 15/06/2021 Ajout du champ « application_date » en entrée et en sortie de la ressource /plics/eligibility

1.3 01/09/2021 Ajout du champ « comment_ce » en sortie de la ressource /dpp_requests/historic


6

2 Introduction

Ce document décrit l’API Tariff mise à disposition par RTE à ses clients dans le but d’exposer (en consultation) des données contractuelles ayant une incidence tarifaire sur la facturation de l’Accès au Réseau :

Demandes de modification de puissances souscrites (PS)

Demandes de modification de version tarifaire (VT)

Demandes de dépassement ponctuel programmé (DPP)

Documents de référence

Référence courte

Titre du document Référence complète

[R1] CGU des API RTE Lien d’accès

2.1 Définitions

Les termes utilisés dans le Guide d’Utilisation et dont la première lettre est une majuscule sont définis ci-dessous ou, à défaut, dans les Conditions Générales d’Utilisation [R1] :

API Application Programming Interface (Interface de programmation applicative)

Authentification Mode de Protection permettant de s’assurer que l’identité de l’Émetteur ou du Récepteur a été vérifiée par RTE et qu’il est donc autorisé à accéder au SI et à utiliser les Applications.

DPP Dépassement Ponctuel Programmé

EIC « Energy Identification Code », système d’identification unique des acteurs et des objets du marché de l’énergie (ex : entités, zones, points de mesures, liaisons électriques d’interconnexion), défini par l’ENTSO-E.

Émetteur Partie qui émet un Message.

ENTSO-E Association « European Network of Transmission System Operators for Electricity » (www.entsoe.eu), association qui rassemble des GRT Européens

Message Ensemble de données informatiques destiné à véhiculer des informations et structuré selon un ordre spécifié dans le Guide d’Utilisation. Un Message

peut être émis par l’Utilisateur ou RTE.

Méthode Une méthode est la manière dont le client interagit avec la ressource de l’API. Il s’agit d’un verbe http (par exemple : GET pour lecture)

Partie ou Parties Dans le cadre du Guide d’Utilisation, il s’agit, individuellement, soit de RTE soit de l’Utilisateur et, conjointement, de RTE et de l’Utilisateur.

PS Puissance Souscrite (kW)

RdC Report de charge

Récepteur Partie qui reçoit le Message de l’Émetteur.

Ressource Une ressource représente la donnée sur laquelle l’application cliente interagit.

https://data.rte-france.com/fr/cgu


7

URL Uniform Resource Locator : chaîne de caractères suivant un format spécifique permettant de localiser une ressource sur un réseau et d’identifier un moyen d’agir (protocole) sur cette ressource.

Utilisateur(s) Personne morale ayant validé les Conditions Générales d’Utilisation des API

de RTE et accédant au SI de RTE afin d’utiliser les API mises à dispositions par RTE.

VT Version Tarifaire

2.2 Assistance technique

En cas de difficulté pour l’accès ou l’utilisation d’une API, l’Utilisateur peut faire appel aux services d’assistance téléphonique mis en place par RTE dans les conditions techniques prévues dans les Conditions Générales d’Utilisation.


8

3 Description fonctionnelle de l’API « Tariff »

3.1 Description générale

L’API Tariff met à disposition des données contractuelles permettant aux clients CART de :

• Vérifier l'éligibilité d'un PLIC (ou d'un ensemble de PLICs) pour un type de demande donné

• Consulter ses données de puissances souscrites et de versions tarifaires

• Consulter le statut et l’historique des demandes de :

o puissances souscrites

o dépassement ponctuel programmé

o versions tarifaires

3.2 Pré-requis à l’utilisation des API

L’API Tariff est destinée aux Clients CART.

3.2.1 Confidentialité des données

Les informations contenues dans les Messages ne pourront être utilisées à d’autres fins que celles prévues dans les Conditions Générales d’Utilisation [R1].

3.2.2 Résiliation

L’abonnement à une API est automatiquement résilié lorsque l’utilisateur supprime son compte sur le

Portail DATA RTE.

Si l’Utilisateur souhaite ne plus utiliser une API sans résilier l’abonnement, il suffit de cesser l’émission des appels à l’API.

3.3 Ressource « /plics/eligibility »

La ressource POST /plics/eligibility permet à un utilisateur de vérifier si un (ou plusieurs) PLIC est éligible à un type de demande donné (PS, VT ou DPP). Le client a la possibilité de consulter pour un ou plusieurs PLIC :

L’éligibilité permanente : il est possible de faire ce type de demande sur ce PLIC dans l’absolu

L’éligibilité contextuelle : il est possible de faire ce type de demande sur ce PLIC à une date

donnée

L’éligibilité permanente et contextuelle (cumul)

Elle est uniquement accessible en lecture, via une méthode de type POST.

3.4 Ressource « /plics/state »

La ressource POST /plics/state permet à un utilisateur de consulter les puissances souscrites et la version tarifaire en cours d’un ou plusieurs PLIC.


3.5 Ressource « /plics/ps/historic »

La ressource POST /plics/ps/historic permet à un utilisateur de consulter l’historique de puissances souscrites pour un PLIC.



9

3.6 Ressource « /plics/vt/historic »

La ressource POST /plics/vt/historic permet à un utilisateur de consulter l’historique de version tarifaire pour un PLIC.


3.7 Ressource « /ps_requests/status »

La ressource POST /ps_requests/status permet à un utilisateur de consulter le statut des demandes de puissances souscrites pour un établissement


3.8 Ressource « /ps_requests/historic »

La ressource POST /ps_requests/historic permet à un utilisateur de consulter l’historique des demandes de puissances souscrites pour un ou plusieurs PLICs


3.9 Ressource « /dpp_requests/status »

La ressource POST /dpp_requests/status permet à un utilisateur de consulter le statut des

demandes de Dépassement Ponctuel Programmé pour un établissement.


3.10 Ressource « /dpp_requests/historic »

La ressource POST /dpp_requests/historic permet à un utilisateur de consulter l’historique des demandes de Dépassement Ponctuel Programmé pour un ou plusieurs PLICs.


3.11 Ressource « /vt_requests/status »

La ressource POST /vt_requests/status permet à un utilisateur de consulter le statut des demandes de version tarifaire pour un établissement.


3.12 Ressource « /vt_requests/historic »

La ressource POST /vt_requests/historic permet à un utilisateur de consulter l’historique des demandes de version tarifaire pour un ou plusieurs PLICs.



10

4 Accès à l’API

L’accès à l’API décrite dans ce document se fait via le protocole REST / JSON.

Comme pour toutes les API mises à disposition par RTE, l’accès et l’utilisation de ces API sont soumis

aux termes des Conditions Générales d’Utilisation [R1].

La méthode d’autorisation d’accès à l’API est une authentification par jeton d’accès

(OAuth2), dont les usages sont décrits dans la FAQ. Les utilisateurs de l’API doivent créer un compte

sur le portail digital de RTE. La création de ce compte permet d’obtenir des identifiants OAuth 2.0. Ces identifiants sont ensuite requis lors des appels à l’API.

A noter que le code EIC de la société (SIREN) est requis pour l’utilisation de ces API. Pour obtenir un code EIC, il est nécessaire de renseigner le formulaire disponible à l’adresse suivante :

https://www.services-rte.com/fr/formulaire-code-eic.html

https://data.rte-france.com/fr/faq

https://www.services-rte.com/fr/formulaire-code-eic.html


11

5 Ressources exposées par l’API « Tariff »

5.1 Ressource /plics/eligibility

5.1.1 POST /plics/eligibility

5.1.1.1 Modalités d’appel

La ressource est exposée de la manière suivante :

Exposition REST / JSON

Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/eligibility

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/plics/eligibility

(*) La sandbox vous permet de tester l’accessibilité de l’API ainsi que de visualiser le format de données retourné depuis le portail DATA. L’appel à la ressource n’est pas paramétrable et retourne toujours la

même donnée.

Important : Pour des raisons de performance et de robustesse, cette ressource est limitée à 100 plics en entrée (champ « plics »). Au-delà de cette limitation, un message d’erreur technique pourra vous être retourné.

5.1.1.2 Entrées

5.1.1.2.1. Requête

Nom Description Card. Type Valeurs / Format

max_return Nombre de résultat retourné maximum 0..1 Numérique Entier positif

superior_at Index à partir duquel les résultats sont retournés

0..1 Numérique Entier positif

5.1.1.2.2. Corps du message


request_type Type de demande 1..1 Texte

Valeurs attendues :

P (Puissance Souscrite)

V (Version tarifaire)

D (Dépassement ponctuel programmé)

permanent_contextual_eligibility

Eligibilité permanente, contextuelle ou les 2

1..1 Texte

Valeurs attendues :

PE (Permanente)

CO (Contextuelle)

PC (Permanente et contextuelle)

plic_type Type d'identifiant des ID de plics transmis dans le champ « plics »

1..1 Texte

Valeurs attendues :

ref_id (Code SAP du Plic

code_eic (Code EIC du Plic)

plics Liste des ID de plics 1..N Liste Exemple :

["100000","10001","100002"]

https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/eligibility


12

application_date Date d’effet 0..1 string Format: yyyyMMdd (20210310)

Exemples d’appel :

Appel avec tous les paramètres :

URL:

POST /private_api/tariff/v1/plics/eligibility?max_return=100&superior_at=0

HTTP/1.1

Headers:

Host: digital.iservices.rte-france.com

Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v1PW2UX6bF8z

Body:

{

"request_type":"V",

"permanent_contextual_eligibility":"PE",

"plic_type":"ref_id",

"plics":["113802","113803"]

"application_date": "20210310"

}

5.1.1.3 Sorties

5.1.1.3.1. Entête http


count Nombre d’occurrences correspondant aux critères de filtre sans tenir compte de la pagination


5.1.1.3.2. Corps http

Tableau de valeurs {JSON} structuré comme suit :

1..

N


company_eic_code Code EIC de la société 1..1 Texte Exemple :

17X0000000000

plic_type Type d’identifiant du Plic 1..1 Texte

plic_id Identifiant de plics 1..1 Texte

request_type Type de demande 1..1 Texte P, V ou D


Eligibilité permanente, contextuelle ou les 2

1..1 Texte PE, CO ou PC

etablishment_ref_id ID de l’Etablissement 1..1 Texte

etablishment_name Nom de l’établissement 1..1 Texte

plic_ref_id Numéro de Plic 1..1 Texte Code à 6 chiffres

plic_code_eic Code EIC du Plic 1..1 Texte Format code EIC

status Statut (OK ou KO) 1..1 Texte


13

refusal_cause Cause de refus 0..1 Texte Vide si statut OK. Si statut KO, la cause de refus sera l’une des valeurs du tableau ci-dessous.

application_date Date d’effet 0..1 Texte

Dans le cas où le champ status est à KO, le champ refusal_cause peut prendre l’une des valeurs suivantes :

Valeurs possibles du champ refusal_cause

EL_ERR01 PLIC au domaine de tension de facturation HTB3 non éligible à une modification de PS

EL_ERR02 PLIC à injection ou PLIC de simulation tarifaire non éligibile à une modification de PS

EL_ERR03 PLIC de soutirage « secours » ou PLIC au domaine de tension de facturation HTB3 non éligible à une modification de VT

EL_ERR04 PLIC à injection ou PLIC de simulation tarifaire non éligibile à une modification de VT

EL_ERR05 PLIC de soutirage « secours » ou PLIC au domaine de tension de facturation HTB3 non éligible à une demande de DPP

EL_ERR06 PLIC raccordé HTA (HTA1 ou HTA2) non éligible à une demande de DPP

EL_ERR07 PLIC à injection non éligible à une demande de DPP

EL_ERR08 PLIC de simulation tarifaire non éligible à une demande de DPP

EL_ERR0 Une demande de modifications de PS est déjà en cours

EL_ERR10 Une demande de modifications de VT est déjà en cours

EL_ERR11 Une demande de modifications de VT a déjà été réalisée il y a moins de 12 mois

EL_ERR12 Une demande de DPP est déjà en cours

EL_ERR13 Une demande de DPP a déjà été effectuée sur cette année (DPP non transitif)

Exemple :

HTTP/1.1 200 OK

count : 2

[

{

"company_eic_code" : "17X0000000001",

"plic_type": "",

"plic_id": "",

"request_type" : "v",

"permanent_contextual_eligibility" : "permanent",

"establishment_ref_id" : "10212",

"establishment_name" : "Etablissement A",

"plic_ref_id" : "113803",

"plic_code_eic" : "17X0000000002",

"status" : "OK",


14

"refusal_cause" : "",


},

{

"company_eic_code" : "17X0000000001",

"plic_type": "",

"plic_id": "",

"request_type" : "v",

"permanent_contextual_eligibility" : "permanent",

"establishment_ref_id" : "10212",

"establishment_name" : "Etablissement A",

"plic_ref_id" : "113803",

"plic_code_eic" : "17X0000000002",

"status" : "KO",

"refusal_cause" : " EL_ERR02 - PLIC à injection ou PLIC de simulation tarifaire non éligibile à une modification de PS",


}

]

5.1.1.4 Règles de gestion

Règle de gestion en fonction des paramètres d’entrée :

Paramètres en entrée concernés par la règle

de gestion Description Numéro

superior_at max_return

Les paramètres de type numérique doivent être des

entiers positifs TARIFF-RG01

request_type permanent_contextua

l_eligibility plic_type

plics

Paramètres obligatoires TARIFF-RG02

request_type La valeur doit être égale à P, V ou D TARIFF-RG03


La valeur doit être égale à PE, CO ou PC TARIFF-RG04

5.1.1.5 Codes erreurs

Le tableau suivant liste les codes erreurs pouvant être retournés lors de l'appel à la ressource.

Type d’erreur Code erreur Détails

Fonctionnelle COMMON_CHECK_AUTORISATION_F06 §6.1.11

Fonctionnelle TARIFF_ELIGIBILITY_F01 §6.1.1


15





Technique TARIFF_ELIGIBILITY_T01 §6.2.1

5.2 Ressource /plics/state

5.2.1 POST /plics/state




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/state

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/plics/state

(*) La sandbox vous permet de tester l’accessibilité de l’API ainsi que de visualiser le format de données retourné depuis le portail DATA. L’appel à la ressource n’est pas paramétrable et retourne toujours la même donnée.


5.2.1.2 Entrées

5.2.1.2.1. Requête





order_by

Tri de la liste des résultats avec le format : ‘<clef> ASC’ ou ‘<clef> DESC’ permettant de faire un tri sur l’un des champs suivants :

plic_label

application_date_vt application_date_ps

0..1 Texte Exemple :

plic_label desc



https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/state


16

plic_type Type d'identifiant des ID de plics transmis dans le champ « plics »

1..1 Texte

Valeurs attendues :




["100000","10001","100002"]



URL:

POST /private_api/tariff/v1/plics/state?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{

"plic_type": "ref_id",

"plics": ["113802", "113803"]

}

5.2.1.3 Sorties







1..

N


company_eic_code Société appelante code EIC

1..1 Texte

etablishment_ref_id Numéro de l’Etablissement 1..1 Texte


plic_code_eic Code EIC du Plic 1..1 Texte

plic_label Libellé du PLIC 1..1 Texte

pracc Pracc 0..1 Texte

current_tariff_version VT courante 0..1

Texte Les valeurs possibles sont ZHTB1_CU, ZHTB1_LU, ZHTB1_MU,ZHTA_CU,ZHTA_LU,ZHTB2_MU,ZHTB2_LU ou ZHTB2_CU.

application_date_ps Date d’effet PS 0..1 Texte Format : yyyyMMdd


17

application_date_vt Date d’effet VT 0..1 Texte Format : yyyyMMdd

plic_type Type d’identifiant du Plic 1..1 Texte


plic_calendar Calendrier du PLIC 0..1 Texte

time_range_list Liste des plages temporelles

1..

5

time_range Plage temporelle 1..1 Texte

current_ps PS associée 1..1 Texte

reference_period_start_date

Date de début de période de référence

1..1 Texte Format : yyyyMMdd


Exemple :

HTTP/1.1 200 OK

count : 1

[

{

"company_eic_code":"17X0000000001",

"establishment_ref_id":"0000010212",

"establishment_name":"Etablissement A",

"plic_code_eic":"17X0000000002",

"plic_label":"Poste A",

"pracc":"0.0",

"current_tariff_version":"ZG3C_HTB_1",

"application_date":"20150601",

"plic_calendar":"",

"time_range_list":[

{

"time_range":"HPTE",

"current_ps":"20000.0",

"reference_period_start_date":"20150601", "plic_id":"0000100001"

},

{

"time_range":"HPSH",

"current_ps":"20000.0",

"reference_period_start_date":"20150601",

"plic_id":"0000100001"

},

{

"time_range":"HCSH",

"current_ps":"20000.0",


"plic_id":"0000100001"

},


18

{

"time_range":"HPSB",

"current_ps":"20000.0",


"plic_id":"0000100001"

},

{

"time_range":"HCSB",

"current_ps":"20000.0",


"plic_id":"0000100001"

}

]

}

]





Fonctionnelle TARIFF_STATE_F01 §6.1.2

Fonctionnelle TARIFF_STATE_F02 §6.1.2

Technique TARIFF_STATE_T01 §6.2.2

5.3 Ressource /plics/ps/historic

5.3.1 POST /plics/ps/historic




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/ps/historic

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/plics/ps/historic


5.3.1.2 Entrées

5.3.1.2.1. Requête



https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/eligibility


19

superior_at Index à partir duquel les résultats sont retournés 0..1 Numérique Entier positif



plic_type Type d'identifiant de plics transmis dans le champ « plic_id »

1..1 Texte

Valeurs attendues :

ref_id (Code SAP du Plic)


plic_id Identifiant du Plic 1..1 Texte



URL:

POST /private_api/tariff/v1/plics/ps/historic?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"plic_id": "113802"

}

5.3.1.3 Sorties







1..

N


company_eic_code Société appelante code EIC

1..1 Texte





plic_type Type d'identifiant du Plic 1..1 Texte

plic_id Identifiant du plic 1..1 Texte

historic Historique des puissances souscrites


20

1..

N


application_date Date d’effet 1..1 Texte Format : yyyyMMdd


1..

5




requested_ps Puissance souscrite demandée

1..1 Texte



1..1 Texte

Format : yyyyMMdd

retroactive_power

Puissance rétroactive 0..1 Texte

Format : yyyyMMdd

retroactive_date Date rétroactive 0..1 Texte

Exemple :

HTTP/1.1 200 OK

count : 1

[

{ "company_eic_code":" 17X0000000001", "establishment_ref_id":" 10212",

"establishment_name":"Etablissement A", "plic_id":"100001", "plic_code_eic":" 17X0000000002",

"plic_type":"code_eic", "plic_label":" Poste A",

"historic":[

{

"plic_id":"100001",


"time_range_list":[

{



"requested_ps":"26500.0",


"retroactive_power":"0.0",

"retroactive_date":"00000000",

"plic_id":"100001"

},

{





21




"plic_id":"100001"

},

{







"plic_id":"100001"

},

{







"plic_id":"100001"

},

{

"time_range":"HCSB",






"plic_id":"100001"

}

]

}

]

}

]





Fonctionnelle TARIFF_PLICS_PS_HISTORIC_F01 §6.1.3



22


Technique TARIFF_PLICS_PS_HISTORIC_T01 §6.2.3

5.4 Ressource /plics/vt/historic

5.4.1 POST /plics/vt/historic




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/vt/historic

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/plics/vt/historic


5.4.1.2 Entrées

5.4.1.2.1. Requête







plic_type Type d'identifiant de plics transmis dans le champ « plic_id »

1..1 Texte

Valeurs attendues :



plic_id Identifiant du Plic 1..1 Texte



URL:

POST /private_api/tariff/v1/plics/vt/historic?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


https://digital.iservices.rte-france.com/private_api/tariff/v1/plics/vt/historic


23

"plic_id": "113802"

}

5.4.1.3 Sorties







1..

N


company_eic_code Société appelante code EIC 1..1 Texte







historic Historique des versions tarifaires

1..

N

tariff_version Version tarifaire

1..1 Texte Les valeurs

possibles sont ZHTB1_CU, ZHTB1_LU,

ZHTB1_MU,ZHTA_CU,ZHTA_LU,ZHTB2_MU,ZHTB2_LU et

ZHTB2_CU.






Exemple :

HTTP/1.1 200 OK

count : 1

[

{

"company_eic_code": "17X0000000001",

"establishment_ref_id": "0000010212",

"establishment_name": "Etablissement A",


24

"plic_id": "100001",

"plic_code_eic": "17X0000000002",


"plic_label": "Poste A",

"historic": [

{

"tariff_version": "ZHTB1_LU",

"application_date": "20180101",

"reference_period_start_date": "20180101",

"plic_id": "100001"

}

]

}

]





Fonctionnelle TARIFF_PLICS_VT_HISTORIC_F01 §6.1.4



Technique TARIFF_PLICS_VT_HISTORIC_T01 §6.2.4

5.5 Ressource /ps_requests/status

5.5.1 POST /ps_requests/status




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/ps_requests/status

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/ps_requests/status



25

5.5.1.2 Entrées

5.5.1.2.1. Requête







establishment_ref_id Numéro d’Etablissement 1..1 Texte

request_number Liste des numéros de demande RTE 1..N Texte



URL:

POST /private_api/tariff/v1/ps_requests/status?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"request_number": ["56695", "56696"]

}

5.5.1.3 Sorties







1..

N


company_eic_code Société ppelante code EIC 1..1 Texte Exemple :

17X0000000000


establishment_name Nom de l’Etablissement 1..1 Texte

request_number Numéro de demande RTE 1..1 Texte

status Statut 1..1 Texte


26

refusal_cause Cause de refus 0..1 Texte

Valeurs possibles du champ status et mapping correspondant :

Valeurs possibles du

champ status Mapping correspondant au statut de la demande de PS

2 En cours

A En cours

1 Validée

4 Refusée

3 Traitée

9 Traitée

C Traitée

B Annulée

8 En cours


PS_ERR01 Modification de PS non réalisée car " Baisse après Hausse " pour HPTE

PS_ERR03 Modification de PS non réalisée car " Baisse après Hausse " pour HPSH

PS_ERR04 Modification de PS non réalisée car " Baisse après Hausse " pour HCSH

PS_ERR09 Baisse après hausse

PS_ERR10 Modif. des PS hivernales en période estivale

PS_ERR15 Variation de PS non respectée

PS_ERR16 Les PS > à la PRACC et PLIC Distributeur

PS_ERR28 PS demandées identiques aux PS actuelles, aucune modification effectuée

PS_ERR29 Erreur de modification de PS, cas métier non valide pour HPTE

PS_ERR30 Erreur de modification de PS, cas métier non valide pour HPSH

PS_ERR31 Erreur de modification de PS, cas métier non valide pour HPSB

PS_ERR32 Erreur de modification de PS, cas métier non valide pour HCSH

PS_ERR33 Erreur de modification de PS, cas métier non valide pour HCSB

PS_ERR34 Modification de PS non réalisée car " Baisse après Hausse " pour SECOURS

PS_ERR36 Modification de PS non réalisée car " Baisse après Hausse " pour HPSB

PS_ERR37 Modification de PS non réalisée car " Baisse après Hausse " pour HCSB

PS_ERR38 Erreur de modification de PS, cas métier non valides sur plusieurs plages

PS_ERR39 Baisse de PS prise en compte avec pour effet une baisse d'une ou plusieurs PS hivernales

PS_ERR41 Erreur "PS inférieure à la PS avant la période de Disposition Particulière"

PS_ERR47 Interclassement non respecté pour les PS

PS_ERR48 Erreur de modification de PS, cas métier non valide pour SECOURS


27

PS_ERR49 Demande refusée suite au traitement manuel RTE

PS_ERR50 PS dem < PS avant Disposition Particulière

PS_ERR51 Aucune modification à effectuer

PS_ERR52 Il existe une demande en cours pour ce PLIC.

Exemple :

http/1.1 200 OK

count : 2

[

{



"establishment_name":" Etablissement A ",

"request_number":"0000056600",

"status":"B",

"refusal_cause":""

},

{

"company_eic_code”:" 17X0000000001",


"establishment_name":"Etablissement A",

"request_number" : "0000072349",

"status" : "4",

"refusal_cause » : "Modif. Des PS hivernales en période estivale"

}

]





Fonctionnelle TARIFF_PS_REQUESTS_STATUS_F01 §6.1.5

Fonctionnelle TARIFF_PS_REQUESTS_STATUS_F02 §6.1.5

Technique TARIFF_PS_REQUESTS_STATUS_T01 §6.2.5

5.6 Ressource /ps_requests/historic

5.6.1 POST /ps_requests/historic





28

Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/ps_requests/historic

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/ps_requests/historic



5.6.1.2 Entrées

5.6.1.2.1. Requête





order_by

Tri de la liste des résultats avec le format : ‘<clef> ASC’ ou ‘<clef> DESC’

permettant de faire un tri sur l’un des champs suivants :

establishment_name

plic_label

request_number

application_date

status


plic_label desc




status Statut 1..N Texte

start_date Date de début 0..1 Texte Format : yyyyMMdd

end_date Date de fin 0..1 Texte Format : yyyyMMdd

plic_type Type d'identifiant du Plic 1..1

Texte Valeurs attendues :




["100000","10001","100002"]




29

URL:

POST /private_api/tariff/v1/ps_requests/historic?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{

"request_number": "56695",

"status": ["1", "4"],

"start_date":"20160101",

"end_date":"20200811",


"plics": ["113802", "113803"]

}

5.6.1.3 Sorties







1..

N


company_eic_code Société ppelante code EIC 1..1 Texte




etablishment_name Nom Etablissement 1..1 Texte






requester_name Nom du demandeur 1..1 Texte

request_date Date et heure de demande 1..1 Texte Format : yyyyMMdd




30


pracc Pracc au moment de la demande

1..1 Texte


1..

5


requested_ps PS demandée 1..1 Texte

current_ps PS courante 1..1 Texte

movement Mouvement 1..1 Texte




retroactive_power Puissance rétroactive 0..1 Texte

retroactive_date Date rétroactive 0..1 Texte Format : yyyyMMdd


champ status Mapping correspondant au statut de la demande de PS

2 En cours

A En cours

1 Validée

4 Refusée

3 Traitée

9 Traitée

C Traitée

B Annulée

8 En cours


PS_ERR01 Modification de PS non réalisée car " Baisse après Hausse " pour HPTE

PS_ERR03 Modification de PS non réalisée car " Baisse après Hausse " pour HPSH

PS_ERR04 Modification de PS non réalisée car " Baisse après Hausse " pour HCSH

PS_ERR09 Baisse après hausse

PS_ERR10 Modif. des PS hivernales en période estivale

PS_ERR15 Variation de PS non respectée

PS_ERR16 Les PS > à la PRACC et PLIC Distributeur

PS_ERR28 PS demandées identiques aux PS actuelles, aucune modification effectuée

PS_ERR29 Erreur de modification de PS, cas métier non valide pour HPTE


31

PS_ERR30 Erreur de modification de PS, cas métier non valide pour HPSH

PS_ERR31 Erreur de modification de PS, cas métier non valide pour HPSB

PS_ERR32 Erreur de modification de PS, cas métier non valide pour HCSH

PS_ERR33 Erreur de modification de PS, cas métier non valide pour HCSB

PS_ERR34 Modification de PS non réalisée car " Baisse après Hausse " pour SECOURS

PS_ERR36 Modification de PS non réalisée car " Baisse après Hausse " pour HPSB

PS_ERR37 Modification de PS non réalisée car " Baisse après Hausse " pour HCSB

PS_ERR38 Erreur de modification de PS, cas métier non valides sur plusieurs plages

PS_ERR39 Baisse de PS prise en compte avec pour effet une baisse d'une ou plusieurs PS hivernales

PS_ERR41 Erreur "PS inférieure à la PS avant la période de Disposition Particulière"

PS_ERR47 Interclassement non respecté pour les PS

PS_ERR48 Erreur de modification de PS, cas métier non valide pour SECOURS

PS_ERR49 Demande refusée suite au traitement manuel RTE

PS_ERR50 PS dem < PS avant Disposition Particulière

PS_ERR51 Aucune modification à effectuer

PS_ERR52 Il existe une demande en cours pour ce PLIC.


champ movement Mapping correspondant au mouvement

H Hausse

B Baisse

BS Baisse

= =

HB Hausse après Baisse

E

Exemple :

HTTP/1.1 200 OK

count : 1

[

{



"plic_id": "100001",


"plic_code_eic":"17X0000000002",

"plic_label":"Poste A"

"start_date": "00000000",


32

"end_date": "00000000",

"status":"4",


"requester_name":"Marie Martin",

"request_date":"20200821",


"refusal_cause":"Modif. des PS hivernales en période estivale",

"pracc":"0.0",


"time_range_list":[

{



"current_ps":"1100.0",

"movement":"E",



"retroactive_date":"00000000"

},

{




"movement":"E",




{




"movement":"E",




{




"movement":"E",




},

{



33



"movement":"E",




}

]

}

]





Fonctionnelle TARIFF_PS_REQUESTS_HISTORIC_F01 §6.1.6

Fonctionnelle TARIFF_ PS_REQUESTS_HISTORIC_F02 §6.1.6

Fonctionnelle TARIFF_ PS_REQUESTS_HISTORIC_F03 §6.1.6

Technique TARIFF_ PS_REQUESTS_HISTORIC_T01 §6.2.6

5.7 Ressource /dpp_requests/status

5.7.1 POST /dpp_requests/status




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/dpp_requests/status

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/dpp_requests/status


5.7.1.2 Entrées

5.7.1.2.1. Requête






34







URL:

POST /private_api/tariff/v1/dpp_requests/status?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"request_number": ["56695", "56696"]

}

5.7.1.3 Sorties







1..

N



17X0000000000






counterproposal Contre-proposition 0..1 Texte


champ status Mapping correspondant au statut de la demande de DPP


35

2 En cours

A En cours

1 Validée

D En cours

R Refusée contractuellement

F Refusée exploitation

G1 Refusée exploitation avec proposition encore modifiable

G2 Refusée exploitation avec proposition ne pouvant plus être modifiée

3 Traitée

B Annulée

8 En cours


DPP_ERR01 DPP non transitif déjà en cours ou traitée

DPP_ERR02 Délai prévenance non respecté

DPP_ERR03 DPP transitive impossible pour client cons-prod

DPP_ERR04 La durée du DPP dépasse la limite maximale

DPP_ERR05 Annulé client

DPP_ERR06 Annulé RTE pour contraintes réseaux

DPP_ERR07 Annulé RTE pour incompatibilité avec travaux pour le poste

DPP_ERR08 Autre

Exemple :

http/1.1 200 OK

count : 2

[

{




"status": "E",

"refusal_cause": "Délai prévenance non respecté !",

"counterproposal": "",

"establishment_name": "Etablissement A"

},

{





36

"status": "E",

"refusal_cause": "Délai prévenance non respecté !",

"counterproposal": "",

"establishment_name": "Etablissement B"

}

]





Fonctionnelle TARIFF_DPP_REQUESTS_STATUS_F01 §6.1.7

Fonctionnelle TARIFF_DPP_REQUESTS_STATUS_F02 §6.1.7

Technique TARIFF_DPP_REQUESTS_STATUS_T01 §6.2.7

5.8 Ressource /dpp_requests/historic

5.8.1 POST /dpp_requests/historic




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/dpp_requests/historic

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/dpp_requests/historic



5.8.1.2 Entrées

5.8.1.2.1. Requête





order_by Tri de la liste des résultats avec le format : ‘<clef> ASC’ ou ‘<clef> DESC’


plic_label desc


37


establishment_name

plic_label

request_number

start_date_and_time

status adjusted_pmax












["100000","10001","100002"]



URL:

POST /private_api/tariff/v1/dpp_requests/historic?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"status": ["1", "4"],

"start_date":"20160101",

"end_date":"20200811",


"plics": ["113802", "113803"]

}

5.8.1.3 Sorties




38





1..

N













request_date Date et heure de demande 1..1 Texte Format : yyyyMMdd

start_date_and_time Date et heure de début 1..1 Texte Format : ddMMyyyyHH24mmss

end_date_and_time Date et heure de fin 1..1 Texte Format : ddMMyyyyHH24mmss



proposed_start_date_and_time

Date et heure de début proposée

0..1 Texte Format : ddMMyyyyHH24mmss

proposed_end_date_and_time

Date et heure de fin proposée

0..1 Texte Format : ddMMyyyyHH24mmss

proposed_pmax Pmax proposée 0..1 Texte

pracc Pracc 1..1 Texte

adjusted_pmax Pmax corrigée 1..1 Texte

transitive_request Demande transitive 1..1 Texte 'Y' : Oui

'N' : Non

justification_document Justificatif de travaux fourni ?

0..1 Texte

'YES' : Oui

'NO' : Non

'NA' : Non Applicable

work_location Emplacement des travaux 1..1 Texte


39

comment_ce Commentaire du centre exploitation concernant la demande de DPP

0..1 Texte


champ status Mapping correspondant au statut de la demande de DPP

2 En cours

A En cours

1 Validée

D En cours

R Refusée contractuellement

F Refusée exploitation

G1 Refusée exploitation avec proposition encore modifiable

G2 Refusée exploitation avec proposition ne pouvant plus être modifiée

3 Traitée

B Annulée

8 En cours


DPP_ERR01 DPP non transitif déjà en cours ou traitée

DPP_ERR02 Délai prévenance non respecté

DPP_ERR03 DPP transitive impossible pour client cons-prod

DPP_ERR04 La durée du DPP dépasse la limite maximale

DPP_ERR05 Annulé client

DPP_ERR06 Annulé RTE pour contraintes réseaux

DPP_ERR07 Annulé RTE pour incompatibilité avec travaux pour le poste

DPP_ERR08 Autre

Exemple :

HTTP/1.1 200 OK

count : 1

[

{



"plic_id": "100001",

"plic_code_eic": "17X0000000002",


40



"start_date": "20160101",

"end_date": "20200811",

"status": "G",


"requester_name": "Marie Martin",

"request_date": "20200730",

"start_date_and_time": "2020052500000000",

"end_date_and_time": "2020053000000000",

"refusal_cause": "TEST AMZ",

"counterproposal": "TEST AMZ",

"adjusted_pmax": "8345678.00",

"transitive_request": "",

"work_location": "",

"justification_document": "NO",


"comment_ce": "ABCD"

}

]





Fonctionnelle TARIFF_DPP_REQUESTS_HISTORIC_F01 §6.1.8



Technique TARIFF_DPP_REQUESTS_HISTORIC_T01 §6.2.8

5.9 Ressource /vt_requests/status

5.9.1 POST /vt_requests/status




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/vt_requests/status

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/vt_requests/status


41


5.9.1.2 Entrées

5.9.1.2.1. Requête











URL:

POST /private_api/tariff/v1/vt_requests/status?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"request_number": ["56695", "56696"]

}

5.9.1.3 Sorties







1..

N



17X0000000000



42






champ status Mapping correspondant au statut de la demande de VT

2 En cours

1 Validée

4 Refusée

3 Traitée

9 Traitée

B Annulée

8 En cours

Exemple :

http/1.1 200 OK

count : 2

[

{



"status":"E",

"refusal_cause":"Délai prévenance non respecté !"


"establishment_name":"Etablissement A"

},

{

"company_eic_code”:" 17X0000000003",

"request_number" : "0000072349",

"status" : "G",

"refusal_cause » : "Modif. Des PS hivernales en période estivale"


"establishment_name":"Etablissement 3"

}

]




43



Fonctionnelle TARIFF_VT_REQUESTS_STATUS_F01 §6.1.9

Fonctionnelle TARIFF_VT_REQUESTS_STATUS_F02 §6.1.9

Technique TARIFF_VT_REQUESTS_STATUS_T01 §6.2.9

5.10 Ressource /vt_requests/historic

5.10.1 POST /vt_requests/historic




Méthode POST

URL ressource https://digital.iservices.rte-france.com/private_api/tariff/v1/vt_requests/historic

URL sandbox (*) https://digital.iservices.rte-france.com/private_api/tariff/v1/sandbox/vt_requests/historic

(*) La sandbox vous permet de tester l’accessibilité de l’API ainsi que de visualiser le format de données retourné depuis le portail DATA. L’appel à la ressource n’est pas paramétrable et retourne toujours la

même donnée.


5.10.1.2 Entrées

5.10.1.2.1. Requête





order_by

Tri de la liste des résultats avec le format : ‘<clef> ASC’ ou ‘<clef> DESC’


etablishment_name

plic_label

request_number

application_date status


plic_label desc


44












["100000","10001","100002"]



URL:

POST /private_api/tariff/v1/vt_requests/historic?max_return=100&superior_at=0

HTTP/1.1

Headers:



Body:

{


"status": ["1", "4"],

"start_date":"20160101",

"end_date":"20200811",


"plics": ["113802", "113803"]

}

5.10.1.3 Sorties







1..

N




45











time_and_date_of_the_request

Date et heure de demande 1..1 Texte Format : ddMMyyyyHH24mmss




current_vt VT courante lors de la demande

1..1 Texte

Les valeurs possibles sont ZHTB1_CU, ZHTB1_LU, ZHTB1_MU,ZHTA_CU,ZHTA_LU,ZHTB2_MU,ZHTB2_LU ou ZHTB2_CU.


Date de début de la période de référence


tariff_version_requested VT demandée 1..1 Texte

Les valeurs possibles sont ZHTB1_CU, ZHTB1_LU, ZHTB1_MU,ZHTA_CU,ZHTA_LU,ZHTB2_MU,ZHTB2_LU ou ZHTB2_CU.


champ status Mapping correspondant au statut de la demande de VT

2 En cours

1 Validée

4 Refusée

3 Traitée

9 Traitée

B Annulée

8 En cours


46


VT_ERR01 Modif. de VT existante de moins de 12 mois

Exemple :

HTTP/1.1 200 OK

count : 1

[

{



"plic_id": "100001",


"start_date": "20160101",

"end_date": "20200811",

"plic_code_eic": "17X0000000002",


"status": "3",


"requester_name": "Marie Martin",

"time_and_date_of_the_request": "2017080900000000",

"application_date": "20170801",

"refusal_cause": "",

"current_vt": "ZHTB1_MU",

"reference_period_start_date": "20170801",

"tariff_version_requested": "ZHTB1_CU",

"establishment_name": "Etablissement A"

}

]





Fonctionnelle TARIFF_VT_REQUESTS_HISTORIC_F01 §6.1.10



Technique TARIFF_VT_REQUESTS_HISTORIC_T01 §6.2.10


47

6 Détails des erreurs

Le schéma ci-dessous présente les codes retournés à l’Utilisateur de l’API en fonction du séquencement des appels.

Ce paragraphe concerne les erreurs génériques à toutes les ressources de l’API et à ce titre il ne décrit pas les erreurs de requêtes (code http 400). Ces erreurs sont décrites ressource par ressource dans le paragraphe correspondant.

En cas d’erreur lors de la phase d’authentification (validation du login et du mot de passe) un code HTTP 401 « unauthorized » est retourné à l’appelant.

La seconde étape est de vérifier que l’Utilisateur ne dépasse pas le nombre maximal d’appels autorisé pour l’organisation. En cas de dépassement, l’appelant en est informé par un code HTTP 429. La réponse du serveur contient dans ce cas un entête "Retry-After:" indiquant le temps d'attente (en secondes) que le client doit attendre avant de renvoyer sa demande.

La troisième étape est de vérifier si l’appelant (identifié par le jeton OAuth2 ou le certificat PKI) a bien créé une application sur le Portail Data. Si ce n’est pas le cas l’appelant en est informé par un code HTTP 403 « forbidden ».

La quatrième étape consiste à vérifier si l'API est bien associée à l’application (notion d'abonnement). Si ce n’est pas le cas, l’appelant en est informé par un code HTTP 403 « forbidden ».

La cinquième étape consiste à accéder aux ressources de RTE. Diverses erreurs fonctionnelles peuvent se produire. Celles-ci sont communiquées à l’Utilisateur en tant qu’erreur JSON avec un code http 400.


48

En cas d’incident technique lors du traitement de la requête quelle que soit l’étape, l’appelant en sera informé par un code HTTP 500.

Structure JSON :

{

"error": "libelle_court, codification explicite de l’erreur",

"error_description": "libellé long, lisible par un utilisateur",

"error_uri": "Voir le Guide de l'utilisateur de l'API ou la FAQ sur https://data.rte-france.com"

"error_details" : {

"transaction_id" : "identifiant unique d’appel, utile en cas d’incident"

}

}

Le libellé court (« error ») est un code permettant à l’application appelante de traiter

automatiquement les messages des erreurs. Il est représenté par une suite de mots séparés

par des « _ ».

Le libellé long (« error_description ») est une description permettant aux utilisateurs de

comprendre de façon plus précise l’origine de l’erreur. Ce libellé doit être validé par le métier

afin de s’assurer qu’il est suffisamment explicite.

L’URI vers le guide d’utilisation est présent pour donner plus d’explications en fonction de l’Api

appelée.

Le champ transaction_id : fournit un identifiant unique d’appel. Cet identifiant peut être

communiqué aux services d’assistance RTE en cas d’incident.

6.1 Erreurs fonctionnelles

6.1.1 /plics/eligibility

Ce tableau récapitule les erreurs fonctionnelles retournées par la ressource correspondant à une erreur

dans la requête (code http 400) :

TARIFF_ELIGIBILITY_F01

RG At least one mandatory parameter is missing

Message Au moins un paramètre obligatoire n’est pas valorisé


RG Parameter permanent_contextual_eligibility is invalid.

Message Le paramètre permanent_contextual_eligibility est invalide


RG Parameter request_type is invalid.

Message Le paramètre request_type est invalide


RG Parameter plic_type is invalid.

Message Le paramètre plic_type est invalide


49


RG No PLIC found for provided ids

Message Aucun PLIC ou code EIC trouvé pour les ID passé dans l’appel.

6.1.2 /plics/state



TARIFF_STATE_F01



TARIFF_STATE_F02

RG No PLIC or code EIC found for the parameters provided

Message Aucun PLIC ou code EIC trouvé pour les ID passé dans l’appel

6.1.3 /plics/ps/historic



TARIFF_PLICS_PS_HISTORIC_F01









6.1.4 /plics/vt/historic



TARIFF_PLICS_VT_HISTORIC_F01







50




6.1.5 /ps_requests/status



TARIFF_PS_REQUESTS_STATUS_F01



TARIFF_PS_REQUESTS_STATUS_F02

RG No request found for parameters provided

Message Aucune demande trouvée pour les paramètres fournis

6.1.6 /ps_requests/historic



TARIFF_PS_REQUESTS_HISTORIC_F01







RG Start date > End date

Message La date de début est supérieure à la date de fin

6.1.7 /dpp_requests/status



TARIFF_DPP_REQUESTS_STATUS_F01



TARIFF_DPP_REQUESTS_STATUS_F02




51

6.1.8 /dpp_requests/historic



TARIFF_DPP_REQUESTS_HISTORIC_F01









6.1.9 /vt_requests/status



TARIFF_VT_REQUESTS_STATUS_F01



TARIFF_VT_REQUESTS_STATUS_F02



6.1.10 /vt_requests/historic



TARIFF_VT_REQUESTS_HISTORIC_F01










52

6.1.11 Erreur Générique

Ce tableau décrit l’erreur fonctionnelle retournée par la ressource correspondant à une erreur

d’habilitation (code http 403) :

COMMON_CHECK_AUTORISATION_F06

RG Cette erreur est générée si la société a bien accès au service de données mais ne possède pas d’habilitation pour l’ensemble des points de service spécifiés.

Message The company has access to the data service but is not authorized for the following service points

6.2 Erreurs techniques

6.2.1 /plics/eligibility

Ce tableau décrit l’erreur technique retournée par la ressource correspondant à une erreur interne

détectée lors du traitement de la demande (code http 500) :

TARIFF_ELIGIBILITY_T01

Message Service unavailable

Description Erreur générée en cas d’erreur interne détectée lors du traitement de la

demande. La demande de service est alors rejetée.

6.2.2 /plics/state



TARIFF_STATE_T01




6.2.3 /plics/ps/historic



TARIFF_PLICS_PS_HISTORIC_T01




6.2.4 /plics/vt/historic



TARIFF_PLICS_VT_HISTORIC_T01



53



6.2.5 /ps_requests/status



TARIFF_PS_REQUESTS_STATUS_T01




6.2.6 /ps_requests/historic



TARIFF_PS_REQUESTS_HISTORIC_T01




6.2.7 /dpp_requests/status



TARIFF_DPP_REQUESTS_STATUS_T01




6.2.8 /dpp_requests/historic



TARIFF_DPP_REQUESTS_HISTORIC_T01




6.2.9 /vt_requests/status



TARIFF_VT_REQUESTS_STATUS_T01



54



6.2.10 /vt_requests/historic



TARIFF_VT_REQUESTS_HISTORIC_T01




6.2.11 Erreur Générique

401

Code http 401

Message unauthorized

Description Erreur générée lorsque l’authentification a échouée

403

Code http 403

Message Forbidden

Description Erreur générée si l’appelant n’est pas habilité à appeler la ressource

404

Code http 404

Message Not Found

Description La ressource appelée n’existe pas ou aucune page n’a été trouvée

408

Code http 408

Message Request Time-out

Description Erreur générée sur non réponse du service appelé ou retour en timeout (http

408) du service appelé.

413

Code http 413

Message Request Entity Too Large

Description La taille de la réponse de la requête dépasse 7Mo

414

Code http 414

Message Request-URI Too Long

Description L’URI transmise par l’appelant dépasse 2048 caractères.


55

429

Code http 429

Message Too Many Requests

Description Le nombre d’appel maximum dans un certain laps de temps est dépassé.

500

Code http 500

Message Internal Server Error

Description

Toute autre erreur technique.

(Cette erreur est accompagnée d’un message JSON avec un champ error_code

et error_description)

503

Code http 503

Message Service Unavailable

Description Erreur générée sur maintenance (http 503).

509

Code http 509

Message Bandwidth Limit Exceeded.

Description L‘ensemble des requêtes des clients atteint la limite maximale.

FIN DU DOCUMENT

Guide d'utilisation-API Données déclarative et NEBEF détaillé

Documents

Transcript of Guide d'utilisation-API Données déclarative et NEBEF détaillé