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 |
|---|---|---|---|
| input | GetDocumentsByProjectInput | Mandatory | GetDocumentsByProject 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) |
GetDocumentsByProjectInput
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| ProjectId | long | Mandatory/Optional | The project Id of the project |
| ProjectCode | string | Optional/Mandatory | Project code of the project E.g. ABC0001-A1 |
Note :
Need to provide at least one of these fields - ProjectId or ProjectCode
Response
| Type | Description |
|---|---|
| GetDocumentsByProjectOutput | GetDocumentsByProjectOutput Model |
GetDocumentsByProjectOutput
Parameter | Type | Comments |
|---|---|---|
| ProjectDocuments | List<ProjectDocument> | Project Document response model list |
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
| 123 | An exception occurred while processing your request |
| 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 |
| 227 | The 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 |
0 Comments