Description
This method is used to return a list of documents uploaded by the user for a given plant. The document list contains all the documents uploaded by the user for the given plant.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
input | GetMyDocumentsByPlantIdInput | Mandatory | Not relevant | GetMyDocumentsByPlantIdInput model |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
GetMyDocumentsByPlantIdInput
| Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
| plantId | long | Mandatory | The provided plantId should belong to the same company as the user. |
Request - sample input
Response
| Type | Description |
|---|---|
GetMyDocumentsByPlantIdOutput | GetMyDocumentsByPlantIdOutput model |
GetMyDocumentsByPlantIdOutput
| Parameter | Type | Description |
|---|---|---|
| Document | List<Document> | List of documents uploaded by the user for the given plantId |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
111 | plantId does not exist for your company |
130 | Input plantId is either zero or negative. Please enter a positive value for the id |
132 | plantId does not exist |
| 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 method |
Add Comment