GetDocumentsByProject - Obsolete
- Janith Weerasinghe (Unlicensed)
- Sandrina Abeywardene (Unlicensed)
- Shamal Perera (Unlicensed)
Owned by Janith Weerasinghe (Unlicensed)
NOTE:
This method is obsolete and will be completely removed in the near future. Please use the new method,GetDocumentsByProject2 which provides more meta data.
Description
This method is used to return a list of documents added to a project. All users that belong to a company that is associated with the project can access all the project documents.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| projectId | long | Mandatory/Optional | Not Relevant | The Id of the project |
| projectCode | string | Optional /Mandatory | Not Relevant | The code of the project E.g. ABC0001-A1 |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
NOTE: It is mandatory to provide either the projectCode or projectId. First preference is always given to the projectId, if both the projectCode and projectId are provided.
Request - sample input
Response
| Type | Description |
|---|---|
| List<ProjectDocument> | A list of project documents for the given project |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
| 123 | An exception occurred while processing your request |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName 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 or your license does not authorize you to access this project |
| 252 | No input is provided for the projectId or the projectCode. Provide the input for at least one of these fields |
| 253 | Ambiguous inputs. Make sure projetCode and projectId referred to the same project |
| 254 | Invalid projectCode |