AddImageToProperty

Description

This method is used to add an image to a property. It displays the image to all owners of the specified property who have not uploaded an image. If a particular owner has already added an image, it will NOT be replaced by this. 

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
inputAddImageToPropertyInputMandatoryNot RelevantPlant Id and Either URL Or Data is mandatory
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

Request - input sample

<AddImageToProperty>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <PlantId>6539</PlantId>
      <PropertyImage>
        <Url>https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQBLVUTEfwcBSoQz_SNLw41VH_B76zVbXMgw1FPlQ26cYgC61MyPA</Url>
        <Data isNull="false" />
      </PropertyImage>
    </input>
    <applicationName>ws</applicationName>
  </MethodParameters>
</AddImageToProperty>

Response


TypeDescription
List<AddImageToPropertyOutput>Includes PropertyOwnerId along with the status of whether the image is uploaded or not


Response - output sample

<AddImageToProperty>
  <MethodParameters>
    <AddImageToPropertyOutputArray>
      <AddImageToPropertyOutputArray0>
        <PropertyOwnerId>550</PropertyOwnerId>
        <IsImageUploaded>True</IsImageUploaded>
      </AddImageToPropertyOutputArray0>
      <AddImageToPropertyOutputArray1>
        <PropertyOwnerId>549</PropertyOwnerId>
        <IsImageUploaded>False</IsImageUploaded>
      </AddImageToPropertyOutputArray1>
    </AddImageToPropertyOutputArray>
  </MethodParameters>
</AddImageToProperty>

Exceptions

Error CodeDescription
110Input parameters contain null or invalid data
123An exception occurred while processing your request
130Input plantId is either zero or negative. Please enter a positive value for the id
132plantId does not exist
136Provided Url is invalid
138applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
167You are not authorized to use this method
202This operation can be done on plants connected to properties 
377You are not authorized to perform this action
379One or more of given Base64 strings as image inputs are not valid images
386One or more of the given Urls for image inputs are not valid image file types
387Both Url and Data are provided for one or more of the inputs. Use either one in each input