ZC - Delete Record

Tags:  


Delete Record  (Get method)


The GET calling convention is supported for testing purpose only.  For production purpose, use HTTP POST method.

Overview

Zoho Creator REST style Web API allows client applications to delete records from a Zoho Creator form, using the HTTP GET method. The records that satisfy the given criteria will be deleted. You can specify multiple criteria using "AND"/ "OR" operator. In return the user gets a formatted XML/CSV/JSON response from the called method.

Who can delete a record ?

Only the owner of the application with valid APIKey can delete a record in Zoho Creator.

Delete record using record id

Request URL

XML 

http://creator.zoho.com/api/xml/<applicationName>/<formName>/<recordId>/delete/apikey=<API Key>&ticket<Ticket>

CSV

http://creator.zoho.com/api/csv/<applicationName>/<formName>/<recordId>/delete/apikey=<API Key>&ticket<Ticket>

JSON

http://creator.zoho.com/api/json/<applicationName>/<formName>/<recordId>/delete/apikey=<API Key>&ticket<Ticket>


Request Parameters

The request parameters comprises of criteria and reloperator.

Field
 Description
applicationName
 The name of the application.
formName
 The name of the form in the application.
recordID
 The unique record id generated by Zoho Creator for each record in the form.

Sample Request

http://creator.zoho.com/api/xml/recruitment/Employee/2000000003003/delete/
apikey=a14289d3322417901bea85df60f96101&ticket=xxxxxxxxxxxxxxxxxxx


Sample Response

The following is the XML response for the above request:
 


<?xml version="1.0" encoding="UTF-8" ?>
    <response>
        <result>
            <form name="Employee">
                <delete>
                    <criteria>
                                        <fieldname="ID" compOperator="EQUALS" value="2000000003003"/>
                    </criteria>
                                  <status>Success</status>
                            </delete>
                   </form>
        </result>
</response>


Equivalent CSV response


Form Name, Operation
Employee,delete
Status,Criteria
Success,[ID EQUALS 2000000003003]


Equivalent JSON response


{
    "formname":
        [
            "Employee",
                {
                    "operation":
                        [
                            "delete",
                            {
                                "Criteria":
                                    [
                                        "ID EQUALS 2000000003003"
                                    ]
                            },
                            {
                                "status":
                                    [
                                        "Success"
                                    ]
                            }
                        ]
                }
        ]
}



Delete record with criteria using AND operator

XML:

http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/
delete/matchall/<criteriaString>/apikey=<API Key>

CSV:

http://creator.zoho.com/api/test/csv/<applicationName>/<formName>/
delete/matchall/<criteriaString>/apikey=<API Key>

JSON:

http://creator.zoho.com/api/test/json/<applicationName>/<formName>/
delete/matchall/<criteriaString>/apikey=<API Key>


Request Parameters

The request parameters comprises of criteria and reloperator.

Field
 Description
applicationName
 The name of the application.
formName
 The name of the form in the application.
criteriaString
 The criteria must be specified in the format "<criteria column name> <operator> <value>"

where,

<Criteria Column Name >: The column name used to specify the delete criteria.
<operator>:The operator used in the criteria. The following operators are supported:
  • !=
  • <=
  • >=
  • <
  • >
  • =
 <value> : The criteria column value.

Sample Request


http://creator.zoho.com/api/test/xml/recruitment/Employee/delete/matchall/Name=Jessy,Hobbies=Writing/
apikey=a14289d3322417901bea85df60f96101


Sample Response

The following is the XML response for the above request:


<?xml version="1.0" encoding="UTF-8" ?>
    <response>
        <result>
            <form name="Employee">
                <delete>
                    <criteria>
                                        <fieldname="Name" compOperator="EQUALS" value="Jessy"/>
                                        <reloperator>And</reloperator>
                                        <fieldname="Hobbies" compOperator="Equals" value="Writing" />
                    </criteria>
                                  <status>Success</status>
                            </delete>
                   </form>
        </result>
</response>


Equivalent CSV response


Form Name, Operation
Employee,delete
Status,Criteria
Success,[Name Equals Henry And Hobbies Equals Reading]


Equivalent JSON response


{"formname":["Employee",{"operation":["delete",{"Criteria":["Name Equals Henry And ID Equals 2000000000323"]},{"status":["Success"]}]}]}



Delete record with criteria using OR operator

XML:

http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/
delete/matchany/<criteriaString>/apikey=<API Key>

CSV:

http://creator.zoho.com/api/test/csv/<applicationName>/<formName>/
delete/matchany/<criteriaString>/apikey=<API Key>

JSON:

http://creator.zoho.com/api/test/json/<applicationName>/<formName>/
delete/matchany/<criteriaString>/apikey=<API Key>

Request Parameters

The request parameters comprises of criteria and reloperator.

Field
 Description
applicationName
 The name of the application.
formName
 The name of the form in the application.
criteriaString
 The criteria must be specified in the format "<criteria column name> <operator> <value>"

where,

<Criteria Column Name >: The column name used to specify the delete criteria.
<operator>:The operator used in the criteria. The following operators are supported:
  • !=
  • <=
  • >=
  • <
  • >
  • =
 <value> : The criteria column value.

Sample Request
 

http://creator.zoho.com/api/test/xml/recruitment/Employee/delete/matchany/HRA_Eligibility=true,Basic<15000/
apikey=a14289d3322417901bea85df60f96101


Sample Response

The following is the XML response for the above request:



<?xml version="1.0" encoding="UTF-8" ?>
 <response>
 <result>
 <form name="Employee">
 <delete>
 <criteria>
 <fieldname="HRA_Eligibility" compOperator="Equals" value="true" />
 <reloperator>Or</reloperator>
 <fieldname="Basic" compOperator="LessThan" value="15000" />
</criteria>

 <status>Success</status>
 </delete>
 </form>
 </result>
 </response>



Equivalent CSV response


Form Name, Operation
Employee,delete
Status,Criteria
Success,[Basic LessThan 15000 Or HRA_Eligibility Equals true]


Equivalent JSON response


{
    "formname":
        [
            "Employee",
                {
                    "operation":
                        [
                            "delete",
                                {
                                    "Criteria":
                                        [
                                            "Basic LessThan 15000 Or HRA_Eligibility Equals true"
                                        ]
                                },
                                {
                                        "status":
                                            [
                                                "Success"  
                                            ]
                                }
                        ]
                }
        ]
}


Note: If you are not logged in to your account, you have to get the ticket and send in the request.

 

 RSS of this page