View Record - XML Format
Request URL
The request url to view a record in xml format is
given below.
http://creator.zoho.com/api/xml/read/apikey=[APIKEY]&ticket=[Ticket]
Request Format
The
request parameters comprises of comma separated values to be
specified in the following format:
<ZohoCreator><application name="app name">
<criteria><field name="field1" compOperator="EQUALS" value="xxx"></field>
<reloperator>AND</reloperator>
<field name="Age" compOperator="EQUALS" value="2"></field>
</criteria> <range>
<startindex>1</startindex>
<limit>100</limit>
</range>
</form>
</application> </ZohoCreator>
|
Note:
1. The values that can be specified for the <compOperator> is given below:
- Equals
- NotEqual
- Before
- After
- LessThan
- GreaterThan
- LessThanOrEqual
- GreaterThanOrEqual
- Contains
- NotContains
- StartsWith
- EndsWith
2. The values that can be specified for the <reloperator> is given below:
3. For fields of type multi-select, only one list value can be specified as criteria.
4. Only Deluge Script names must be specified for form names, field names and application name. Refer http://creator.zoho.com/api/reference to view the list of
applications created, the form names and field names used in each
application and the deluge names.
5. The <range>
tag enables you to limit the number of records to be displayed in the
view. It is optional. If <range> tag is not specified, the
default values will be set as startindex = 1 and limit =100. (i.e) the
last first records will be displayed.
6. 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/xml/read/apikey=[APIKEY]&ticket=[Ticket]">
<input type="hidden" name="XMLString" value="XML String in the format as specified in the Request format">
<input type="submit" value="Sumit XML String">
</form> |
Sample Request
Sample request to view a record:
<ZohoCreator>
<application name="sample"> <form name="Employee_Form"> <criteria>
<field name="Name" compOperator="EQUALS" value="Nicholas"></field>
</criteria>
</form> </application>
|
Sample Response
The response parameters comprises of form name, criteria and the records that match the specific criteria.
| <response> <form name="Employee_Form">
<criteria> <field name="Name" compOperator="EQUALS" value="Nicholas"/>
</criteria> <records>
<record>
<column name="ID">3000000012255</column>
<column name="Name">Nicholas</column>
<column name="Address">"10, NorthWing St, NY, USA"</column>
<column name="E-mail">nick@yahoo.com</column>
<column name="Joining Date">25-Jun-2006</column>
<column name="Hobbies">Music,Gardening</column>
<column name="Qualification">M.C.A</column>
<column name="Basic">50000</column>
<column name="Department">Accounts</column>
</record>
</records>
</form>
|
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 record is added to the database, the response message will be displayed with status as "Success".
