Versions Compared

Key

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

Description

This method returns a list of documents uploaded by the user for a given plant. The document list contains all the document uploaded by the user for the given plant. 

Request

ParameterTypeMandatory/OptionalComments

input

GetMyDocumentsByPlantIdInput

Mandatory

GetMyDocumentsByPlantIdInput model

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

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

 

Response

TypeDescription

GetMyDocumentsByPlantIdOutput

GetMyDocumentsByPlantIdOutput model

ParameterTypeComments
DocumentList<Document>List of documents uploaded by the user 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

132

PlantId does not exist

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