getTabularRecords

Note: If you’re using the new version of APIs (V2), refer this link.

Purpose

You can use the getTabularRecords method to obtain the tabular information available in a particular record.

Type: GET

URL Format:

https://recruit.zoho.com/recruit/private/xml/<Module>/getTabularRecords?authtoken=<Auth Token>&id=<Candidate Id>&tabularNames=(Experience Details,Educational Details)&scope=recruitapi

For OAuth Authentication

Header Name
Value
Authorization
Zoho-oauthtoken {access_token}

Scopes

Scope=ZohoRecruit.modules.all
(or)
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
Possible Scope Names (Case Sensitive)
Operation Types
referral, campaign, assessment, vendor, offer, attachment,
forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules )
ALL - Full access to the record
READ - Get records from the module

For Authtoken Authentication

Parameter
Data Type
Description
authtoken*
String
Encrypted alphanumeric string to authenticate your Zoho credentials.
scope*
String
Specify the value as recruitapi

Request Parameters

Parameter	Data type	Description
id*	String	Specify the unique ID of the record
tabularNames*	String	Name of the tabular data you required in comma separated format.

Note: Parameters marked with * are mandatory

Supported Modules

Candidates, JobOpenings, Interviews, Contacts, Clients and all Custom Modules

Sample Request:

https://recruit.zoho.com/recruit/private/xml/Candidates/getTabularRecords?authtoken=abbdd****&id=368078000001395033&tabularNames=(Experience Details,Educational Details)

Response

<?xml version="1.0" encoding="UTF-8"?>
<response uri="/recruit/private/xml/Candidates/getTabularRecords">

</TR>
<TR no="1">

<TL val="Major / Department" genType="1" uiType="1" />
<TL val="Degree" genType="1" uiType="1" />
<TL val="Duration_From" genType="1"

uiType="6607"><![CDATA[12-2014]]></TL>
<TL val="Duration_To" genType="1"

uiType="6607"><![CDATA[03-2015]]></TL>
</TR>

</FL>
<FL val="Experience Details">

<TR no="0">
<TL val="Occupation / Title" genType="1"

uiType="1"><![CDATA[Athlete - Pittsburgh, PA]]></TL>
<TL val="Company" genType="1" uiType="1"><![CDATA[Trax,

LLC]]></TL>

</TR>
<TR no="1">

<TL val="Occupation / Title" genType="1"
uiType="1"><![CDATA[Graduate Teaching Assistant (JAVA) - Henniker,

NH]]></TL>
Ovens]]></TL>

<TL val="Company" genType="1" uiType="1"><![CDATA[Prof. Jim

</TR> </FL>

</Candidates>
</result>

</response>

Note:

If the record has two or more values in its multi picklist fields, the response will display the values in semicolon separated format.

Example: <![CDATA[Option 1;Option 2;Option 3]]>

Header Name	Value
Authorization	Zoho-oauthtoken {access_token}

Possible Scope Names (Case Sensitive)	Operation Types
referral, campaign, assessment, vendor, offer, attachment, forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules )	ALL - Full access to the record READ - Get records from the module

Zoho Recruit | getTabularRecords Method