ZC - Add Record

Tags:  

 
Add 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 add record to a Zoho Creator form, using the HTTP GET method. You can add only one record at a time. In return the user gets a formatted XML / CSV / JSON response from the called method.  

Who can add a record ?
  • Public Form: Anyone with a valid apikey can add a record to the Form.
  • Private Form:Only the owner of the application with a valid apikey can add a record to the Form.
  • Shared Form: Any user with a valid apikey and share permission can add a record to the Form.

Request URL

XML  

http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/add/apikey=<API Key>&ticket=[Ticket]&<fieldName>=<value>

CSV

http://creator.zoho.com/api/test/csv/<applicationName>/<formName>/add/apikey=<API Key>&ticket=[Ticket]&<fieldName>=<value>

JSON

http://creator.zoho.com/api/test/json/<applicationName>/<formName>/add/apikey=<API Key>&ticket=[Ticket]&<fieldName>=<value>
Note:

To add records to a public application or a shared application, the application owner name must be specified in the request url as given below:

http://creator.zoho.com/api/test/xml/<applicationName>/<formName>/add/apikey=<API Key>&ticket=[Ticket]&<fieldName>=<value>&<zc_ownername>=<applicationOwnerName>

Request Parameters

The request parameters comprises of criteria and reloperator.

Field
Description
applicationName
The name of the Zoho Creator application.
formName
The name of the form in the application.
fieldName
The field label name
value
The field value

Sample Request

http://creator.zoho.com/api/test/xml/recruitment/Employee/add/
apikey=a14289d3322417901bea85df60f96101&ticket=xxxxxxxxxxxxxxxxxx&Name=John&DOB=10-Jun-1975&Address=10 Downing streetUK&EmailId=john@gmail.com&Hobbies=Reading,Writing&Basic=10000&HRA_Eligibility=true

 


Sample Response

The following is the XML response for the above request:


<?xml version="1.0" encoding="UTF-8" ?>
<response>
<result>
<form name="Employee">
<add>
<values>
<field name="Name">
<value>John</value>
</field>

<field name="EmailId">
 <value>john@gmail.com</value>
</field>

<field name="DOB">
 <value>10-Jun-1975</value>
</field>

<field name="Basic">
 <value>10000</value>
</field>

<field name="Address">
 <value>10 Downing street UK</value>
</field>

<field name="HRA_Eligibility">
<options>
 <option>true</option>
</options>
</field>

<field name="Hobbies">
<options>
 <option>Reading</option>
 <option>Writing</option>
</options>
</field>
</values>

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

 


Equivalent CSV response

Form Name, Operation
Employee , add
Status,Values
Success ,[ Name = John , EmailId = john@gmail.com , DOB = 10-Jun-1975 , Basic = 10000 , Address = 10 Downing street UK , Hobbies = " Reading , Writing " , HRA_Eligibility = true ]

 


Equivalent JSON response

{
    "formname":
        [
            "Employee",
                {
                    "operation":
                        [
                            "add",
                                {
                                    "values":
                                        [
                                            {
                                           "Address":"10 Downing street UK","Basic":"10000", "EmailId":"john@gmail.com","DOB":"10-Jun-1975"
                                            },
                                {
                                    "Hobbies":
                                        [
                                            "Reading, Writing"
                                        ]
                                },
                                {
                                    "status":
                                        [
                                            "Success"
                                        ]
                                }
                                        ]
                                }
                        ]
                }
        ]
}


 

 RSS of this page