This method is obsolete and will be completely removed in the near future. Please use the new web service method, GetDocumentsByPlant - New which provides more metadata.
Description
This method is used to return a list of documents for a given plant in a company. The document list contains all the documents sent to the given plant. The user can include filter criteria (not implemented yet) and select whether to include sub folders in the results.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
plantId | long | Mandatory | Not Relevant | Id of the plant |
includeSubFolders | bool | Mandatory | Not Relevant | Indicates whether documents of the queried plant in child folders should be included |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Notes:
- The plantId provided should belong to the same company as the user.
Request - input sample
Response
| Type | Description |
|---|---|
List<Document> | List of documents for the given plantId |
Response - output sample
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 |
| 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 |
0 Comments