Blogs
   Forums   Creator
 Toll Free : 888 900 9646

API Home >> Creator API  >> CSV API  >> CSV API Methods  >> View Record


 


View Record - CSV Format



Zoho Creator
CSV - RPC Web API allows client applications to view records from a Zoho Creator form, using the HTTP POST method. The records that satisfy the given criteria will be displayed. You can specify multiple criteria using "AND"/ "OR" operator. In return, the user gets a formatted CSV response from the called method. 


Request URL:

The request url to view a record in csv format is given below:

http://creator.zoho.com/api/csv/<application owner name>/read



Request Parameters

The view request parameters comprises of comma seperated values to be specified in the following format. Each line must end with a line seperator.

 


<Application Name>,<Form Name>,<startIndex>, <limit>

<Criteria Column Name >,<operator>,<value>,<AND or OR>



Note: 

 
1. The values that can be specified for the <Operator> is given below:

  • Equals
  • NotEqual
  • Before
  • After
  • LessThan
  • GreaterThan
  • LessThanOrEqual
  • GreaterThanOrEqual
  • Contains
  • NotContains
  • StartsWith
  • EndsWith
2.Only Deluge Script names must be specified for form names, field names and application name. Refer http://creator.zoho.com/api/referenceto view the list of applications created, the form names and field names used in each application and the deluge names.

3.
Field values with special characters must be specified within double quotes.

4.
Multiple list values must be specified within double quotes with each value seperated by a comma.

5. Each line must end with a line seperator.


6. The <startindex> and <limit> enables you to limit the number of records to be displayed in the view. It is mandatory. If this is not specified, the default values will be set as startindex = 1 and limit =100. (i.e) the first 100 records will be displayed.

7. Viewing of records from multiple forms in the same application or from different applications is not supported.



Sample Form (POST Method Format)

<form method="POST"    action="http://creator.zoho.com/api/csv/read/apikey=[APIKEY]&ticket=[Ticket]">
<input type="hidden" name="CSVString" value="CSV String in the format as specified in the Request format">
<input type="submit" value="Sumit CSV String">
</form>


Sample Request

The following is the sample request to view a record:

 


Sample,Employee_Form,
Name,Equals, Kingsley, AND,

E_mail,Equals,king@gmail.com.,




Response Format

The request parameters comprises of comma seperated values.  The line-wise parameters to be specified is given below:

 


Form Name, Criteria, Status
<Name of the form>,<Criteria specified> <Success/Failure>
<Comma Seperated Column Names >

<Comma Seperated Column Values >



If there is an error in the request format, the corresponding error code with the error message will be displayed. Please refer the topic, Error codes and description, to learn about the list of error code displayed.


If the request is successful, the response message will be displayed ini the following format, with status as "Success".



Sample Response 


The following is the sample response for the above method:

 


Form Name , Criteria , Status


dateForm ,Age EQUAL 24 ,Success


ID ,Name ,Age ,DOB


2000000079003 ,Kalai ,24 ,2007-08-20 00:00:00.0