Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This method returns is used to return property and plant information (as described in the outputs below) of all the plants that are created by the current authenticated user’s company.Notes:

If a particular company has created a large number of plants, then the output of this method will be large.  Please note that there can be receiving byte limitations of your API testing client and if the size of the response exceeds that limit, an error can be thrown. 


Request

ApplicationName)
ParameterTypeMandatory/OptionalCommentsMaximum character length/limitDescription
applicationNamestringMandatoryThird party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should Should be less than or equal to 10 charactersThe name of the integration partner

 

Request - sample input

Image Added

Response

TypeDescription
List<Plant>

A list of plant type objects. Each of the list listed elements could be one of on of the following concrete types:

  • PropertyPlant - The plant is connected to a property
  • BuildingPlant - The plant is connected to a building
  • Plant - The plant is not connected to either a property or a building.

 

Response - sample output

Image Added

Exceptions

Error CodeDescription
123An exception occured occurred while processing your request
138ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10)
146The application name is applicationName is not set
167You are not authorized to use this web method


Known issues

If a certain company has created a large number of plants, then the output of this method will be large.  Please note that there can be byte limitations in your API testing client. If the size of the response exceeds that limit, an error can be thrown.