Documentation de service Web / Catégories / Services d'utilisation de la propriété / Obtenir l'utilisation personnalisé de la propriété

Obtenir l'utilisation personnalisé de la propriété

Mise à jour le 28 août 2023

Description

Ce service Web renvoie les renseignements détaillés sur l'utilisation personnalisé d'une propriété donnée. Un message 404 est renvoyé si au moins un détail d'utilisation personnalisé n'a pas été défini. Pour créer un nouveau détail d'utilisation personnalisé, veuillez consulter le site Web. Les renseignements comprennent des données générales sur l'utulisation personnalisé de la propriété et les renseignements les plus récents sur ses caractéristiques personnalisées. La propriété correspondante doit déjà être partagée avec vous.

Version

22.0

Méthode HTTP

GET

URL de la ressource

/customUse/(propertyId)

En-tête

Nom du champ	Valeur	Commentaires
Autorisation	Basic authentifiant

Autorisation requise

Oui

Paramètres

Nom du paramètre	Description
propertyId	Identifiant de la propriété

Schémas XML

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

Exemple de demande

L'exemple suivant permet d'extraire les renseignements actuels sur l'utilisation personnalisé d'une propriété pour une propriété dont l'identifiant est 14.

GET  /customUse/14

Exemple de réponse

L'exemple suivant renvoie les renseignements relatifs à l'utilisation personnalisé d'une propriété s'il y en a un de défini.

<?xml version="1.0" encoding="UTF-8"?>
<customUse>
     <audit>
          <createdBy>CARREYH</createdBy>
          <createdByAccountId>-6</createdByAccountId>
          <createdDate>2023-04-07T12:54:08.000-05:00</createdDate>
          <lastUpdatedBy>CARREYH</lastUpdatedBy>
          <lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
          <lastUpdatedDate>2023-04-07T12:54:08.000-05:00</lastUpdatedDate>
     </audit>
     <name>Entire Property Use</name>
     <useDetails>
          <customUseDetail1 dataType="numeric" id="130086500" currentAsOf="2000-01-01" temporary="false" default="No">
               <audit>
                    <createdBy>CARREYH</createdBy>
                    <createdByAccountId>-6</createdByAccountId>
                    <createdDate>2023-04-21T10:18:27.000-05:00</createdDate>
                    <lastUpdatedBy>CARREYH</lastUpdatedBy>
                    <lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
                    <lastUpdatedDate>2023-04-21T10:18:27.000-05:00</lastUpdatedDate>
               </audit>
               <value>55</value>
               <customName>test detail</customName>
          </customUseDetail1>
          <customUseDetail2 units="Square Feet" dataType="numeric" id="130086501" currentAsOf="2000-01-01" temporary="false" default="No">
               <audit>
                    <createdBy>CARREYH</createdBy>
                    <createdByAccountId>-6</createdByAccountId>
                    <createdDate>2023-04-21T10:18:28.000-05:00</createdDate>
                    <lastUpdatedBy>CARREYH</lastUpdatedBy>
                    <lastUpdatedByAccountId>-6</lastUpdatedByAccountId>
                    <lastUpdatedDate>2023-04-21T10:24:13.000-05:00</lastUpdatedDate>
               </audit>
               <value>120</value>
               <customName>test detail 2</customName>
          </customUseDetail2>
     </useDetails>
</customUse>

header.banner.text