DeleteProject
Description
This method is used to delete projects. Projects in the "Not Started" state without any added documents can be deleted.
Note
Only the project owner is allowed to execute this method. Once a project is deleted, a notification mail is sent to all the companies connected to this project.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| projectId | long | Optional*/Mandatory | 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 |
- It is mandatory to provide either the projectId or projectCode.
Request - input sample
Response
| Type | Description |
|---|---|
| Boolean | Status of the delete action. True - If the given project has been successfully deleted |
Response - output sample
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 |
| 223 | The given project is not owned by the company or does not exist, therefore this action cannot be performed |
| 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 |
| 273 | Project does not exist |
| 292 | Projects which are in In Progress status cannot be deleted |
| 293 | Projects which are in Closed status cannot be deleted |
| 294 | This project cannot be deleted as it contains documents |