...
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| Input | GetDocumentsByProjectInput | Mandatory | GetDocumentsByProjectInput 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 (project Id, project code)
Response
| Type | Description |
|---|---|
| GetDocumentsByProjectOutput | A list of project documents for the given project |
GetDocumentsByProjectOutput
Parameter | Type | Comments |
|---|---|---|
| GetDocumentsByProjectOutput | List<ProjectDocument> | Project Document response model list |
Exceptions
| Error Code | Description |
|---|---|
| 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 |
| 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 |