Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

Description

This web method returns a list of documents added to a project. Any of the users belonging to a company which is associated with the project can access all the project documents.

Note:

  • This web method is an upgraded version of GetDocumentsByProject web method with more meta data. It is advised to use this web method as the previous is deprecated.
  • A single Input parameter (GetDocumentsByProjectInput) 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. 
  • Addition of the new field in the output will be available after the next production release only


Request

Parameter
Type
Mandatory/Optional
Comments
inputGetDocumentsByProjectInputMandatoryGetDocumentsByProject input model
applicationNamestringMandatoryThird party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should be less than or equal to 10)


GetDocumentsByProjectInput

Parameter
Type
Mandatory/Optional
Comments
ProjectIdlongMandatory/OptionalThe project Id of the project
ProjectCodestringOptional/MandatoryProject code of the project E.g. ABC0001-A1 

Note :

Need to provide at least one of these fields - ProjectId or ProjectCode

Response

TypeDescription
GetDocumentsByProjectOutputGetDocumentsByProjectOutput Model

 

GetDocumentsByProjectOutput

Parameter
Type
Comments
ProjectDocumentsList<ProjectDocument>Project Document response model list

 

Exceptions

Error CodeDescription

110

Input parameters contain null or invalid data

123An exception occurred while processing your request
138 ApplicationName length is exceeded maximum allowed character limit (10)
146The application name is not set
167You are not authorized to use this web method
227The project does not exist or the company is not connected to the given project
252 

No input is provided to project Id or project code. Need atleast one of them 

253 

Ambiguous inputs. Make sure projet code and project id referred to the same project 

254 

Invalid project code 

  • No labels