Note:
This is an upgraded version of GetDocumentsByPlantId method with more meta data. It is advisable to use this method as the previous is now obsolete.
GetDocumentsByPlantInput is a single input parameter introduced in this method to enclose all the existing input parameters of the previous method in a single place with the exception of the applicationName.
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 provide the filtering criteria and choose whether to include sub folders in the results.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | GetDocumentsByPlantInput | Mandatory | Not Relevant | GetDocumentsByPlant input model |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - sample input
GetDocumentsByPlantInput
| Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
| PlantId | long | Mandatory | Id of the plant |
| IncludeSubFolders | bool | Mandatory | Indicates whether documents of the queried plant in child folders should be included |
Response
| Type | Description |
|---|---|
| GetDocumentsByPlantOutput | GetDocumentsByPlantOutput model |
GetDocumentsByPlantOutput
| Parameter | Type | Description |
|---|---|---|
| Documents | List<Document> | List of documents for the given plantId |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
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