Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

Description

This method returns 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

ParameterTypeMandatory/OptionalComments
ApplicationNamestringMandatoryThird party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should be less than or equal to 10)

 

Response

TypeDescription
List<Plant>

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

 

Exceptions

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