Guide d`utilisation-API - API Data RTE

Transcription

Guide d’Utilisation API ntc
Version 1.0
GUIDE D’UTILISATION
API NTC
Version 1.0
Date d’entrée en vigueur : 08 Avril 2016
1
Guide d’Utilisation API ntc en version 01.00 de RTE
Version 1.0
SOMMAIRE
1
INTRODUCTION ________________________________________ 3
1.1
1.2
2
Définitions ........................................................................................... 3
Assistance technique ............................................................................ 3
DESCRIPTION FONCTIONNELLE DE L’API NTC _____________________ 5
2.1
2.2
Description générale ............................................................................. 5
Pré-requis à l’utilisation des API ............................................................. 5
2.2.1 Confidentialité des données ...................................................................... 5
2.2.2 Résiliation ................................................................................................ 5
2.3
Ressource « ntc »................................................................................. 5
3
ACCES A L’API ________________________________________ 6
4
RESSOURCE EXPOSEE PAR L’API « NTC » _______________________ 7
4.1
5
Ressource /ntc ..................................................................................... 7
4.1.1 GET /ntc .................................................................................................. 7
4.1.1.1 Modalités d’appel ............................................................................ 7
4.1.1.2
Entrées .......................................................................................... 8
4.1.1.3
Sorties ........................................................................................... 9
4.1.1.4
Règles de gestion ......................................................................... 12
4.1.1.5
Codes erreurs ............................................................................... 15
DETAILS DES ERREURS __________________________________ 16
5.1
Erreurs fonctionnelles ..........................................................................18
5.1.1 ntc ........................................................................................................ 18
5.2
6
Erreurs techniques...............................................................................19
ANNEXES ___________________________________________ 19
6.1
Exemples d’appels ressource « ntc » .....................................................20
6.1.1
6.1.2
6.1.3
6.1.4
6.1.5
6.1.6
6.1.7
6.1.8
Cas
Cas
Cas
Cas
Cas
Cas
Cas
Cas
sans paramètre – NTC-RG01 ............................................................ 20
avec paramètre type – NTC-RG02 ..................................................... 20
avec le code pays – NTC-RG03 ......................................................... 20
avec les dates – NTC-RG04 .............................................................. 21
avec tous les paramètres – NTC-RG05 .............................................. 21
sans données en retour –NTC-RG06 ................................................. 21
maille jour calendaire – NTC-RG08.................................................... 21
changement d’heure–NTC-RG09 ....................................................... 21
2
Version 1.0
1 Introduction
Ce document décrit l’API ntc en version 1 mise à disposition par RTE à ses Clients dans le but d’obtenir
les données de prévisions de NTC (Net Transfer Capacity – Capacité Nette de Transfert) en MW à
différentes échéances (annuelle, mensuelle, hebdomadaire, journalière et réduite le cas échéant). Les
prévisions s’affinent à l’approche du jour de livraison de l’électricité.
Documents de référence
Référence
courte
[R1]
1.1
Titre du document
Référence complète
CGU des API RTE
Lien accès
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
applicative)
Programming
Interface
(Interface
de
programmation
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.
Émetteur
Partie qui émet un Message.
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.
Opération
Une opération 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.
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.
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.
Traduction des valeurs anglaises retournées par l’API :
Valeur en Anglais en sortie de l’API
Traduction en Français
3
ANNUAL
Belgium
CURTAILED
D-1
England
France
Germany
Italy
MONTHLY
Spain
Switzerland
WEEKLY
1.2
Version 1.0
Annuelle
Belgique
Réduite
J-1 (Calculée en J-1)
Angleterre
France
Allemagne
Italie
Mensuelle
Espagne
Suisse
Hebdomadaire
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.
4
Version 1.0
2 Description fonctionnelle de l’API ntc
2.1
Description générale
Une NTC (Net Transfer Capacity – Capacité Nette de Transfert) représente le programme commercial
d’échange maximum entre deux pays en tenant compte des règles de sécurité opérationnelles et des
incertitudes techniques liées aux conditions futures du réseau.
Le Service de cette API permet d’obtenir les données de prévisions de NTC en MW à différentes
échéances (annuelle, mensuelle, hebdomadaire, journalière et réduite le cas échéant). Les prévisions
s’affinent à l’approche du jour de livraison de l’électricité.
2.2
Pré-requis à l’utilisation des API
L’API ntc est destinée aux acteurs du marché de l’électricité et au grand public. Néanmoins les
utilisateurs de l’API doivent créer un compte sur le portail digital du Rte. La création de ce compte
permet d’obtenir des identifiants Oauth 2.0. Ces identifiants sont ensuite requis lors des appels aux API.
2.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].
2.2.2 Résiliation
L’abonnement à une API est automatiquement résilié lorsque l’utilisateur supprime son compte sur le
portail Digital 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.
2.3 Ressource « ntc »
Cette ressource permet d’obtenir les données des Capacités de Transfert Nettes (NTC) à différentes
échéances :
•NTC annuelle (dite ANNUELLE)
•NTC mensuelle (dite MENSUELLE)
•NTC hebdomadaire (dite HEBDOMADAIRE)
•NTC calculée en J-1 (dite J-1)
•NTC réduite (dite REDUITE)
5
3
Version 1.0
Accès à l’API
L’accès à l’API décrite dans ce document se fait via le protocole REST.
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 aux API est OAuth, dont les usages sont décrits dans la FAQ.
6
Version 1.0
4 Ressource exposée par l’API « ntc »
4.1
Ressource /ntc
4.1.1
GET /ntc
4.1.1.1 Modalités d’appel
La ressource est exposée de la manière suivante :
Exposition
REST / JSON
Méthode
GET
https://digital.iservices.rte-france.com/open_api/ntc/v1/ntc?
type=<valeur(s)>&start_date=<valeur>&end_date=<valeur>&country_eic_code=<va
leur(s)>
Où les paramètres type, start_date, end_date et country_eic_code sont les mêmes que
ceux transmis à la ressource par l’appelant.
URL ressource
URL sandbox
(1)
(1)
https://digital.iservices.rte-france.com/open_api/ntc/v1/sandbox/ntc
La sandbox ne prend pas en compte les paramètres d’entrées
Préconisations d’appels
Cette opération a pour objectif de permettre de récupérer à fréquence régulière les mises à jour des
NTC. Dans le cas d’utilisation nominal il n’est pas nécessaire de renseigner les champs de la période.
Le service retourne automatiquement les NTC les plus à jour à sa disposition pour chacune des
échéances de NTC Cf. NTC-RG01.
La recherche peut :

soit se faire sur toutes les frontières et toutes les échéances de NTC, en ne
renseignant aucun des champs en entrée

soit il est possible de préciser une liste de NTC et/ou une liste de frontière. Pour
chacun des pays dans la liste, l’opération retourne l’export et l’import.
Il est conseillé de faire :

un appel par an pour la NTC annuelle

un appel par mois le 27 du mois à partir de 9h00 pour la NTC mensuelle

un appel par semaine le Vendredi à partir de 9h00 pour la NTC hebdomadaire

un appel par jour vers 20h00 pour récupérer la prévision J-1 et la NTC réduite le
cas échéant.
Il n’est pas possible de dépasser une période de 62 jours par appel. Dans le cas ou seul le type annual
est renseigné, il est possible de faire un appel sur une durée de 366 jours.
Ce Service met à disposition des données à partir des dates suivantes:

NTC annuelle : 01/01/2009
7

NTC mensuelle : 01/01/2015

NTC hebdomadaire : 14/05/2010

NTC calculée en J-1 : 30/04/2014

NTC réduite : 28/09/2012
Version 1.0
Les données antérieures à cette date sont disponibles uniquement sous forme de fichiers d’archives
4.1.1.2 Entrées
NOM
CARD.
DESCRIPTION
TYPE
VALEURS / FORMAT
Une des valeurs
suivantes :
ANNUAL
MONTHLY
WEEKLY
D-1
CURTAILED
Une des valeurs
suivantes :
10YCB-GERMANY–8
10YGB———-A
10YBE———-2
10YIT-GRTN—–B
10YES-REE——0
10YCH-SWISSGRIDZ
type
0..n
(3)
Type d’échéance de
enum
la NTC recherché
Country_eic_code
0..n
(3)
Code
du
recherché
start_date
0..1
(2)
Date de début de
recherche
des date
prévisions
YYYY-MMDDThh:mm:sszzzzzz2
end_date
0..1
(2)
Date de
recherche
prévisions
YYYY-MMDDThh:mm:sszzzzzz2
pays
fin
enum
de
des date
REGLES
NTC-RG01
NTC-RG02
NTC-RG05
NTC-RG11
NTC-RG01
NTC-RG03
NTC-RG05
NTC-RG11
NTC-RG01
NTC-RG04
NTC-RG05
NTC-RG07
NTC-RG10
NTC-RG01
NTC-RG04
NTC-RG05
NTC-RG07
NTC-RG10
(1) Par convention, les données relatives à la date end_date sont exclues de la recherche, des données
de réponse du Service.
(2) Si start_date est passé alors end_date doit être passé en paramètre.
(3) Les différents types et pays doivent être séparés par des virgules.
Exemples d’appel :
Sans paramètre
URL:
GET /open_api/ntc/v1/ntc
HTTP/1.1
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
8
Version 1.0
Avec tous les paramètres
URL:
GET
open-api/ntc/v1/ntc?type=MONTHLY,WEEKLY&start_date=2015-06-01T00:00:00%2B02:00&end_date=2015-
06-03T00:00:00%2B02:00&country_eic_code=10YCB-GERMANY–8
HTTP/1.1
Headers:
Host: digital.iservices.rte-france.com
Authorization: Bearer CNAPbfmg7GjvtqTTlKqPm8ykP6R8YJFfJPnyjqW8p1v2PW2UX6bF8z
Body:
0..n
4.1.1.3 Sorties
NOM
CAR
D.
ntc
1..1
NOM
CAR
D.
DESCRIPTION
Tableau de valeurs {JSON} contenant 1 occurrence.
Sa structure est la suivante :
TYP VALEURS /
DESCRIPTION
E
FORMAT
Une des
valeurs
suivantes :
enu ANNUAL
Type d’échéance des NTC
m
MONTHLY
WEEKLY
D-1
CURTAILED
type
1..1
start_date
1..1
Date de début de recherche des
NTC
end_date
1..1
Date de fin de recherche des
NTC
sender_country_na
me
1..1
Nom du pays émetteur
receiver_country_na
me
1..1
Nom du pays receveur
9
REGL
ES
NTCRG06
YYYY-MMNTCdate DDThh:mm:ssz
RG08
zzzzz
YYYY-MMdate DDThh:mm:ssz
zzzzz
Une des
valeurs
suivantes :
Belgium
enu England
m
France
Germany
Italy
Spain
Switzerland
Une des
valeurs
enu suivantes :
m
Belgium
England
France
NTCRG08
–
_
sender_country_eic
_code
1..1
receiver_country_ei
c_code
1..1
values
1..1
Version 1.0
Germany
Italy
Spain
Switzerland
Une des
valeurs
suivantes :
10YCBGERMANY–8
10YGB———enu A
Code EIC du pays émetteur
_
m
10YBE———-2
10YIT-GRTN—
–B
10YES-REE—
—0
10YCHSWISSGRIDZ
Une des
valeurs
suivantes :
10YCBGERMANY–8
10YGB———enu A
Code EIC du pays receveur
_
m
10YBE———-2
10YIT-GRTN—
–B
10YES-REE—
—0
10YCHSWISSGRIDZ
Tableau de valeurs {JSON} structuré comme suit. Un
tableau de valeur par intervalle de temps en fonction du
type et des frontières orientées
sender_country_eic_code et
receiver_country_eic_code
NOM
CAR
D.
DESCRIPT TYP
ION
E
VALEURS /
FORMAT
REGL
ES
Début de
l'intervalle
de temps
RG09
zzzzz
end_date
1..1
Fin de
l'intervalle
de temps
RG09
zzzzz
updated_
date
1..1
Date de
mise à jour
des
données
YYYY-MMdate DDThh:mm:ssz _
zzzzz
value
1..1
Valeur de la
prévision de int
l'intervalle
0..n
start_date 1..1
10
Entier
numérique
–
11
Version 1.0
Version 1.0
Format JSON du retour :
GET /open_api/ntc/v1/ntc
HTTP/1.1 200 OK
{ "ntc" : [
{
"start_date":"2015-09-30T00:00:00+02:00",
"end_date":"2015-10-01T00:00:00+02:00",
"sender_country_eic_code":"10YFR-RTE------C",
"sender_country_name":"France",
"receiver_country_eic_code":"10YGB----------A",
"receiver_country_name":"England",
"type":"D-1",
"updated_date":"2015-11-12T00:00:00+01:00"
"values":[{"start_date":"2015-09-30T00:00:00+02:00","end_date":"2015-0930T01:00:00+02:00","updated_date":"2015-11-12T00:00:00+01:00","value":2000}, ... ]
...
]}
4.1.1.4 Règles de gestion
Règle de gestion en fonction des paramètres d’entrée :
paramètre en entrée
type
vide
renseign
é
vide
start_dat
e
vide
vide
vide
end_date
vide
vide
vide
Country_eic_cod
e
Description
Numér
o
vide
Si aucun paramètre n’est
passé, la ressource retourne
pour chacune des échéances
de NTC et pour chacune des
frontières, la NTC la plus à
jour.
NTCRG01
vide
Si le paramètre type est
passé, la réponse contient
uniquement les types
d’échéances de NTC
demandées.
NTCRG02
Si le paramètre
country_eic_code est
passé, la réponse contient
uniquement les frontières en
import et en export des pays
demandés.
NTCRG03
renseigné
12
vide
renseign
é
renseigné
renseigné
renseign
é
renseign
é
vide
renseigné
Version 1.0
Si les paramètres start_date
et end_date sont passés, le
Service retourne la NTC de
toutes les frontières pour
chaque échéance de NTC. La
recherche est effectuée sur la
période demandée.
si pour l’une des échéances
de NTC et l’une des
frontières, il n’y a pas de
donnée sur la période
demandée, le Service
retourne le type de NTC, la
start_date NTC, la
end_date NTC, le
sender_country_eic_code,
le sender_country_name,
le
receiver_country_eic_cod
e et le
receiver_country_name
sans renseigner les champs
valeurs
Si la période demandée est
inférieure à 1 mois calendaire
et que le champ type n’est
pas renseigné alors le Service
ne retourne pas les NTC
annuelles.
Il est possible de passer au
Service les 4 paramètres pour
obtenir des données ciblées.
Si une valeur est dupliquée
dans l’un des paramètres
énumérés (type ou
country_eic_code, ), alors
le Service ne renvoie cette
valeur qu’une seule fois.
Règles de gestion appliquées en sortie :
Numéro
NTCRG06
Description
Les données de sortie sont triées par type de NTC dans l’ordre suivant :
 CURTAILED / REDUITE
 D-1 / J-1
 WEEKLY / HEBDOMADAIRE
 MONTHLY / MENSUELLE
 ANNUAL / ANNUELLE
13
NTCRG04
NTCRG07
NTCRG10
NTCRG05
NTCRG11
NTCRG08
NTCRG09
Version 1.0
Les données sont retournées à la maille mois calendaire pour la NTC annuelle et à la
maille jour calendaire pour les autres échéances de NTC.
Pour la NTC annuelle, si la période demandée est supérieure à un mois calendaire mais
qu’elle est inférieure à 2 mois calendaires, seul le mois calendaire sera retourné en
sortie du Service.
Exemple : si un appel au Service est effectué pour la NTC annuelle sur une période du
02/04/2015 au 29/06/2015, le Service retourne uniquement la NTC annuelle du mois de
Mai.
Pour les NTC hebdomadaire, J-1 et réduite :


Dans le cas du changement d’heure hiver->été, la valeur de 2H à 3H, heure
Française est vide.
Dans le cas du changement d’heure été->hiver, la valeur de 2H à 3H heure
Française est présente deux fois
14
Version 1.0
4.1.1.5 Codes erreurs
Le tableau suivant liste les codes erreurs pouvant être retournés lors de l'appel à la ressource.
Le détail de ces erreurs est décrit au chapitre 5 Détails des erreurs.
Type d’erreur
Code erreur
Fonctionnelle
NTC_NTC_F01
Fonctionnelle
NTC_NTC_F02
Fonctionnelle
NTC_NTC_F03
Détails
§Erreur ! Source du
envoi introuvable.
envoi introuvable.
envoi introuvable.
Fonctionnelle
NTC_NTC_F04
Fonctionnelle
NTC_NTC_F05
Fonctionnelle
NTC_NTC_F06
Fonctionnelle
NTC_NTC_F07
Technique
404
§5.2
Technique
408
§5.2
Technique
413
§5.2
Technique
414
§5.2
Technique
429
§5.2
Technique
500
§5.2
Technique
503
§5.2
Technique
509
§5.2
15
envoi introuvable.
envoi introuvable.
envoi introuvable.
envoi introuvable.
5
Version 1.0
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 communes à 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és
pour l’opération. 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 que l’application est bien créée/habilitée à accéder à la plateforme
technique VESPA. 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 que l’application a bien souscrit à un abonnement à l’API. 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. Les erreurs décrites
dans ce document sont les erreurs fonctionnelles retournées avec le code retour http 500.
16
Version 1.0
Structure JSON :
{
"error": "libelle_court, codification explicite de l’erreur",
"error_description": "libellé long, lisible par un utilisateur",
"error_uri": "URI vers le guide d’utilisation présent sur la plateforme technique VESPA ou la
FAQ/documentation sur le portail web de VESPA"
"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 utilisé
pour
17
5.1
Version 1.0
Erreurs fonctionnelles
5.1.1 ntc
Ce tableau récapitule les erreurs fonctionnelles retournées par la ressource correspondant à une erreur
dans la requête (code http 400) :
NTC_NTC_F01
RG
Cette erreur est générée si les paramètres start_date et end_date sont passés l’un sans
l’autre.
Message
If one of the fields "start_date" or "end_date" is used, the two fields are mandatory. Please
used either fields or neither.
Exemple
d'appel
GET/open_api/ntc/v1/ntc?start_date=2015-06-01T00:00:00%2B02:00
NTC_NTC_F02
RG
Cette erreur est générée si le paramètre start_date est plus récent que le paramètre
end_date.
Message
The field "start_date" in the API input is more recently than the field "end_date". Please
correct the values of these fields
Exemple
d'appel
RG
Message
Exemple
d'appel
GET/open_api/ntc/v1/ntc?start_date=2015-06-02T00:00:00%2B02:00&end_date=201506-01T00:00:00%2B02:00
NTC_NTC_F03
Cette erreur est générée si la période demandée est supérieure à 62 jours.
The API does not provide feedback on such a long period in one call. To retrieve all the
data please make it with severals calls to the API.
GET:open-api/ntc/v1/ntc?start_date=2015-06-01T00:00:00%2B02:00&end_date=201507-02T00:00:00%2B02:00
NTC_NTC_F04
RG
Message
Exemple
d'appel
RG
Message
Exemple
d'appel
S’il est demandé explicitement la NTC « ANNUELLE » dans le champ « echeance » sur une
période inférieure à 1 mois calendaire le service génère cette erreur.
Si l’intervalle entre la « date_debut » et la « date_fin » est inférieur à 1 jour calendaire, le
service génère cette erreur.
The period filled by fields "start_date" and "end_date" is too short to return values. Please
check the user guide to verify the minimum period for this API.
NTC_NTC_F05
Cette erreur est générée si start_date ou end_date n’a pas le format attendu, le Service
génère cette erreur.
One of the dates in the API input does not follow the format described in the user guide.
Please verify compliance with the format for each field.
NTC_NTC_F06
RG
Cette erreur est générée si type et/ou country_eic_code n’est pas l’une des valeurs
attendues, le Service génère cette erreur.
Message
One of the enumerated field does not match with the list of expected values. Please verify
compliance with the format for each field.
18
Exemple
d'appel
Version 1.0
GET/open_api/ntc/v1/ntc?start_date=2015-06-01&end_date=2015-06-01
NTC_NTC_F07
RG
Cette erreur est générée s’il est demandé explicitement la NTC D-1 et/ou CURTAILED
dans le champ type avec le pays Allemagne et/ou Belgique, le service génère cette erreur.
Message
It is not allowed to ask the NTC of Germany and/or Belgium for the types "D-1" and/or
"CURTAILED"
Exemple
d'appel
GET open_api/ntc/v1/ntc?type=D-5
5.2
Erreurs techniques
6 Annexes
404
Code http 404
Message
Not Found
Exemple
d'appel
La ressource appelé n’existe pas ou aucune donnée n’a été trouvée
408
Code http 408
Message
Request Time-out
Exemple
d'appel
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
Exemple
d'appel
La taille de la requête dépasse 5Mo
414
Code http 414
Message
Request-URI Too Long
Exemple
d'appel
L’URI transmise par l’appelant dépasse 512 caractères.
429
Code http 429
19
Message
Too Many Requests
Exemple
d'appel
Le nombre d’appel maximum dans un certain laps de temps est dépassé.
Version 1.0
500
Code http 500
Message
Exemple
d'appel
Internal Server Error
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
Exemple
d'appel
Erreur générée sur maintenance (http 503).
509
Code http 509
Message
Bandwidth Limit Exceeded.
Exemple
d'appel
L‘ensemble des requêtes des clients atteint la limite maximale.
6.1
Exemples d’appels ressource « ntc »
6.1.1 Cas sans paramètre – NTC-RG01
GET
/ntc/v1/ntc
La réponse JSON est décrite dans le fichier ntcEC03-RG01.v1.0.2.json inclus au fichier zip intitulé
« zip_ntc » fourni en annexe.
6.1.2 Cas avec paramètre type – NTC-RG02
GET
/ntc/v1/ntc?type=D-1
6.1.3 Cas avec le code pays – NTC-RG03
GET
/ntc/v1/ntc?country_eic_code=10YCB-GERMANY–8
20
Version 1.0
6.1.4 Cas avec les dates – NTC-RG04
GET
/ntc/v1/ntc? type=MONTHLY,WEEKLY&start_date=2015-06-01T00:00:00%2B02:00&end_date=2015-06-
03T00:00:00%2B02:00&country_eic_code=10YCB-GERMANY–803T00:00:00%2B02:00
6.1.5 Cas avec tous les paramètres – NTC-RG05
GET
/ntc/v1/ntc?type=MONTHLY,WEEKLY&start_date=2015-06-01T00:00:00%2B02:00&end_date=2015-06-
03T00:00:00%2B02:00&country_eic_code=10YCB-GERMANY–8
6.1.6 Cas sans données en retour –NTC-RG06
GET
/ntc/v1/ntc?start_date=2015-06-01T12:00:00%2B02:00&end_date=2015-06-03T12:00:00%2B02:00
6.1.7 Cas maille jour calendaire – NTC-RG08
GET
/ntc/v1/ntc?start_date=2015-06-01T12:00:00%2B02:00&end_date=2015-06-03T12:00:00%2B02:00
6.1.8 Cas changement d’heure–NTC-RG09
GET
/ntc/v1/ntc?start_date=2015-10-25T00:00:00%2B02:00&end_date=2015-10-
26T00:00:00%2B01:00&country_eic_code=10YCB-GERMANY–8
FIN DU DOCUMENT
21
22
Version 1.0

Guide d`utilisation-API - API Data RTE

Transcription

Documents pareils

Titre : Capteur piezo électrique constitué de graphène et

Fiche application Le Marchand de Sable PDF, 715 ko

Le catalogue des marchandises / des données

TRT 227, 228 : Thermostat d`ambiance

COMMERCIALISATION DE LA MODE

FiveGo DO - Mettler Toledo

problème 10 problème 11

La princesse aux petits prouts

1 Chargeur de batterie au Lithium à entrée double, 1,2 A, à choix