Description
This method is used to add an image to a property. It sets displays the image to all the owners of the specified property who has have not uploaded an image. If a particular owner has already has added an image for the specified property, it will NOT be replaced by this.
...
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | AddImageToPropertyInput | Mandatory | Not Relevant | Plant Id and Either URL Or Data is mandatory |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - input sample
<AddImageToProperty>
<MethodParameters>
<UserAuthentication>
<UserName>username< <UserName>username</UserName>
<Password>password< <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
| Type | Description |
|---|---|
| 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 Code | Description |
|---|---|
| 110 | Input parameters contain null or invalid data |
| 123 | An exception occurred while processing your request |
| 130 | Input plantId is either zero or negative. Please enter a positive value for the id |
| 132 | plantId does not exist |
| 136 | Provided Url is invalid |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 167 | You are not authorized to use this web method |
| 202 | This operation can be done on plants connected to properties |
| 377 | You are not authorized to perform this operation |
| 379 | One or more of given Base64 strings as image inputs are not valid images |
| 386 | One or more of the given URLs Urls for image inputs are not valid Image image file typetypes |
| 387 | Both URL Url and Data are provided for one or more of the inputs. Use either one in each input |
...