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
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| applicationName | string | Mandatory | 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 listed elements could be one of the following types:
|
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
| 123 | An exception occurred while processing your request |
| 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 |
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.