announcement

During the current lapse in appropriations, EPA intends to keep the ENERGY STAR website, tools, and resources available, however they will not be updated regularly. Many services may not be available during this time.

Documentation de service Web / Catégories / Services de signalement / Obtenir l’état de la réponse aux données

Obtenir l’état de la réponse aux données

Mise à jour le 10 octobre 2023

Description

Ce service Web envoie des renseignements sur l’état de la réponse de données spécifique d’un client et toute information utile pour résoudre les erreurs. Le client peut faire référence à un utilisateur auquel vous êtes connecté ou à votre propre compte.

Les statuts suivants sont valides :
  • INITIALIZED - Indique que la configuration de la réponse de données a été initialement créée ou que sa configuration (c’est-à-dire ses propriétés) a été mise à jour.
  • SUBMITTED - Indique que la réponse de données a été soumise pour génération et attend d’être générée.
  • IN_PROCESS - Indique que la réponse de données est en cours de génération.
  • FAILED - Indique que la réponse de données a été générée, mais qu’elle a rencontré une erreur inconnue.
  • GENERATED - Indique que la réponse de données a été générée sans erreurs.
  • GENERATED_WITH_ERRORS - Indique que la réponse de données a été générée avec des erreurs. Des liens sont fournis pour télécharger les erreurs.
  • SENT - Indique que la réponse de données a été envoyée.

Version

25.0

Méthode HTTP

GET

URL de la ressource

/reports/customers/(customerId)/dataResponses/(dataResponseId)/status

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
customerId Identifiant du client
dataResponseId Identifiant de la réponse de données

Schémas XML

Demande/réponse Nom de schéma
Demande Aucun
Réponse response.xsd

Exemple de demande

L’exemple suivant permet d’obtenir l'état d’une réponse de données spécifique ayant un identifiant 9876 qui appartient à un client ayant un identifiant 675434

GET  /reports/customers/675434/dataResponse/9876/status

Exemple de réponses

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web qui ne contient aucune erreur.

<?xml version="1.0" encoding="UTF-8"?>
<responseStatus>
     <status>GENERATED</status>
     <generationStartDate>2023-01-20T15:59:48.696-05:00</generationStartDate>
     <generationEndDate>2023-01-20T15:25:48.752-05:00</generationEndDate>
     <submittedDate>2023-01-10T16:25:48.659-05:00</submittedDate>
</responseStatus>

L’exemple suivant montre les résultats lorsque vous utilisez ce service Web qui contient des erreurs. Des liens sont inclus pour vous aider.

<?xml version="1.0" encoding="UTF-8"?>
<responseStatus>
     <status>GENERATED_WITH_ERRORS</status>
     <generationStartDate>2023-01-20T15:59:48.696-05:00</generationStartDate>
     <generationEndDate>2023-01-20T15:25:48.752-05:00</generationEndDate>
     <submittedDate>2023-01-10T16:25:48.659-05:00</submittedDate>
     <errors>
          <links>
               <link id="9876" httpMethod="GET" link="/ws/reports/customers/675434/dataResponses/9876/errors/download?type=EXCEL" linkDescription="This is the GET url for this DataResponse Errors." hint="Energy Report 2023-DataRequest"/>
               <link id="9876" httpMethod="GET" link="/ws/reports/customers/675434/dataResponses/9876/errors/download?type=XML" linkDescription="This is the GET url for this DataResponse Errors." hint="Energy Report 2023-DataRequest"/>
          </links>
     </errors>
</responseStatus>
ENVIRONNEMENT DE PRODUCTION