Note:
This web method is an upgraded version of GetDocumentsByPlantId - Obsolete web method with more meta data.
- A single Input parameter (GetDocumentsByPlantInput) is introduced in this web method in order to enclose all the existing input parameters of the old web method except for the Application name in a single place.
Description
This method returns a list of documents for a given plant in a company. The document list will contain all the documents sent for the given plant. The client also has option to provide the filtering criteria and choose whether to include sub folders in the results.
Request
| Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input | GetDocumentsByPlantInput | Mandatory | GetDocumentsByPlant input model |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should be less than or equal to 10) |
GetDocumentsByPlantInput
| Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| PlantId | long | Mandatory | Id of the plant |
| IncludeSubFolders | bool | Mandatory | indicates whether to include documents of child folders of the queried plant as well |
Response
| Type | Description |
|---|---|
| GetDocumentsByPlantOutput | GetDocumentsByPlantOutput model |
GetDocumentsByPlantOutput
| Parameter | Type | Comments |
|---|---|---|
| Documents | List<Document> | List of documents for the given plant id |
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
111 | PlantId does not exist for your company. |
130 | Input plant ID is either zero or negative. Please enter a positive value for the id |
| 138 | ApplicationName length is exceeded maximum allowed character limit (10) |
| 146 | The application name is not set |
| 167 | You are not authorized to use this web method |
Add Comment