NOTE:
This method is an upgraded version of GetDocumentsByProject method with more meta data. It is advisable to use this method as the previous is now obsolete.
GetDocumentsByProjectInput is a single input parameter introduced in this method to enclose all the existing input parameters of the previous method in a single place with the exception of the applicationName.
The new output field will only be available after the next production release
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 |
|---|---|---|---|---|
| input | GetDocumentsByProjectInput | Mandatory | Not Relevant | GetDocumentsByProject input model |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
GetDocumentsByProjectInput
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
| ProjectId | long | Mandatory/Optional | The Id of the project |
| ProjectCode | string | Optional/Mandatory | The code of the project E.g. ABC0001-A1 |
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 |
|---|---|
| GetDocumentsByProjectOutput | GetDocumentsByProjectOutput Model |
GetDocumentsByProjectOutput
Parameter | Type | Description |
|---|---|---|
| ProjectDocuments | List<ProjectDocument> | Project Document Response model list |
Response - sample output
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
| 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 |
| 252 | No input is provided for ProjectId or ProjectCode. Provide the input for at least one of these fields |
| 253 | Ambiguous inputs. Make sure the ProjectCode and projectId refer to the same project |
| 254 | Invalid ProjectCode |
0 Comments