Documentation de service Web / Catégories / Services de compte de base / Créer un champ personnalisé

Créer un champ personnalisé

Mise à jour le 9 mai 2014

Description

Ce service Web ajoute un champ personnalisé. Ce champ personnalisé est utilisé par les services Web d'échange de données pendant le processus de connexion et de partage. Prenez note qu'il n'y a aucune validation qui est effectuée sur la commande d'affichage spécifiée.

Version

22.0

Méthode HTTP

POST

URL de la ressource

/dataExchangeSettings/customField

En-tête

Nom du champ	Valeur	Commentaires
Autorisation	Basic authentifiant
Type de contenu	application/xml

Autorisation requise

Oui

Paramètres

Aucun

Schémas XML

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

Exemple de demande

L'exemple suivant montre la création d'un nouveau champ personnalisé au niveau de la propriété.

POST  /dataExchangeSettings/customField

<?xml version="1.0" encoding="UTF-8"?>
<customField validCharacters="Any" required="true" name="Lot Number1" 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>

Exemple de réponse

L'exemple suivant indique que le champ personnalisé a été créé avec succès. Il affiche aussi l'identifiant du nouveau champ personnalisé (46) et un lien Internet vers le service Web pour récupérer le champ personnalisé.

<?xml version="1.0" encoding="UTF-8"?>
<response status="Ok">
    <id>46</id>
    <links>
        <link httpMethod="GET" link="/dataExchangeSettings/customField/46" linkDescription="This is the GET url for this custom field."/>
    </links>
</response>

header.banner.text