Delete Database

Tags:  

Delete Database





Introduction


The Delete Database API is used to delete the database from your Zoho Reports Account. This API will delete the database present in the user account who is invoking this API, and not the database from other accounts. Please note that if a database is deleted using this API, the same database cannot be restored back.

Getting Started


To get started with the below documentation, make sure that you already gone through the Prerequisites and API Specifications documentations. 


Request


The sample request URL is below.


https://reportsapi.zoho.com/api/abc@zoho.com?ZOHO_ACTION=DELETEDATABASE&ZOHO_DATABASE_NAME=EmployeeDB
&
ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML
&authtoken=g38sl4j4856guvncrywox8251sssds&ZOHO_API_VERSION=1.0


Query String Parameters

The below table shows the list of Query String parameters that has to be passed along with the request URL.

Parameter NameDescription
ZOHO_ACTIONThis parameter value should be DELETEDATABASE.

Note:
This parameter should be in same case (UPPER CASE) as given in the document.
ZOHO_DATABASE_NAMEThis parameter holds the name of the database to be deleted
authtoken
The authtoken parameter should hold the Auth Token of the Database Administrator whose database is to be deleted.





Response



The sample response sent from the server if the Delete Database process is success.

XML Format:

<response uri="/api/abc@zoho.com" action="DELETEDATABASE">
<result>
<message>Database deleted successfully</message>
</result>
</response>


JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com",
"action": "DELETEDATABASE",
"result":
{
"message": "Database deleted successfully"
}
}
}


Error Handling



This section explains the possible errors responses that could be returned on failure of the Delete Database API call.

XML Format:

<response uri="/api/abc@zoho.com" action="DELETEDATABASE">
<error> <code>7103</code>
<message>Database not found! Please check whether the database exists</message>
</error>
</response>


JSON Format:

{
"response":
{
"uri": "\/api\/abc@zoho.com",
"action": "DELETEDATABASE",
"error":
{ "code":6021,
"message": "Database not found! Please check whether the database exists"
}
}
}

Error Codes:

The below table shows the list of error codes sent from server on Delete Database API Request along with the reason and the solution for the same.

Error CodeReasonSolution
7103The database specified does not exists
Check the name of the database to be deleted
7165
The database specified is a system database (dedicated database created for other Zoho Service integrations) which cannot be deleted
The system database cannot be deleted


In case you encounter any other errors, please mail the API request URL parameters and error response details to support@zohoreports.com. We will get back to you shortly with the best possible solution.





    Post a comment

    Your Name or E-mail ID (mandatory)

    Note: Your comment will be published after approval of the owner.




     RSS of this page