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.

...

This method returns a list of documents for a given plant in a company. The document list will contain contains all the documents for the Plant ID. The client also has option to provide the filtering sent to the given plant. The user can include filter criteria (not implemented yet) and choose select whether to include sub folders in the results. 

...

ParameterTypeMandatory/OptionalCommentsMaximum character length/limitDescription

plantId

long

Mandatory

Not Relevant

Id of the plant

includeSubFolders

bool

Mandatoryindicates whether to include documents of child folders of

Not Relevant

Indicates whether documents of the queried plant as wellin child folders should be included 

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

 

Notes:

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

Request - input sample

Image Added

Response

TypeDescription

List<Document>

List of documents for the given plant idplantId

 

Response - output sample

Image Added

Exceptions

Error CodeDescription

111

PlantId plantId does not exist for your company.

130

Input plant ID plantId is either zero or negative. Please enter a positive value for the id

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

...