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 compte de base / Récupérer le champ personnalisé

Récupérer le champ personnalisé

Mise à jour le 9 mai 2014

Description

Ce service Web affiche l'information d'un champ personnalisé spécifique.

Version

25.0

Méthode HTTP

GET

URL de la ressource

/dataExchangeSettings/customField/(customFieldId)

En-tête

Nom du champ Valeur Commentaires
Autorisation Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre Description
customFieldId Identifiant du champ personnalisé

Schémas XML

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

Exemple de demande

L'exemple suivant montre la récupération du champ personnalisé dont l'identifiant correspond à 45.

GET  /dataExchangeSettings/customField/45

Exemple de réponse

L'exemple suivant affiche l'information d'un champ personnalisé.

<?xml version="1.0" encoding="UTF-8"?>
<customField validCharacters="Any" required="true" name="Lot Number" whenToPrompt="Property">
     <description>Lot Number for the property in ACME Building system.</description>
     <example>FG 323</example>
     <url>http://www.acme.com</url>
     <minChars>1</minChars>
     <maxChars>12</maxChars>
     <displayOrder>1</displayOrder>
 </customField>
ENVIRONNEMENT D'ESSAI