Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 returns a list of documents for a given plant in a company. The document list will contain all the documents for the Plant ID. The client also has option to provide the filtering criteria (not implemented yet) and choose whether to include sub folders in the results. 

Request

ParameterTypeMandatory/OptionalComments

plantId

long

Mandatory

Id of the plant

includeSubFolders

bool

Mandatory

indicates whether to include documents of child folders of the queried plant as well

applicationNamestringMandatoryThird party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should be less than or equal to 10)

 

Notes:

  • The provided plant ID should belong to the same company as the user. 

Response

TypeDescription

List<Document>

List of documents for the given plant id

 

Exceptions

Error CodeDescription

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

138ApplicationName length is exceeded maximum allowed character limit (10)
146The application name is not set
167You are not authorized to use this web method