GetAllPlants

Description

This method is used to return property and plant information of all the plants that are created by the current user’s company.


Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

 

Request - sample input

Response

TypeDescription
List<Plant>

A list of plant type objects. Each of the listed elements could be one of the following 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

Exceptions

Error CodeDescription
123An exception occurred while processing your request
138applicationName length has exceeded the maximum character limit allowed (10)
146The 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.Â