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
Parameter | Type | Mandatory/Optional | Comments | ApplicationNameMaximum character length/limit | Description |
---|---|---|---|---|---|
applicationName | string | MandatoryThird party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should | Should be less than or equal to 10 | )characters | The name of the integration partner |
Request - sample input
Response
Type | Description |
---|---|
List<Plant> | A list of plant type objects. Each of the list listed elements could be one of on of the following concrete types:
|
Response - sample output
Exceptions
Error Code | Description |
---|---|
123 | An exception occured occurred while processing your request |
138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
146 | The application name is applicationName is not set |
167 | You 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.