「レコードの取得方法」

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

目的

getRecords メソッドを使用することで、API リクエストで指定されたすべてのユーザーデータを取得できます。

リクエストURL

XML形式：

https://recruit.zoho.com/recruit/private/xml/Module/getRecords?authtoken=AuthToken&scope=recruitapi

JSON形式：

https://recruit.zoho.com/recruit/private/json/Module/getRecords?authtoken=AuthToken&scope=recruitapi

注意：モジュールとは、候補者、求人オープニング、クライアント、インタビュー、コンタクト、カスタムモジュール1、カスタムモジュール2、カスタムモジュール3、カスタムモジュール4、およびカスタムモジュール5を指します。

OAuth 認証のため

ヘッダー名	値
承認	Zoho-oauthtoken {アクセストークン}

範囲

スコープ=ZohoRecruit.モジュール.全て

(または)

スコープ=ZohoRecruit.モジュール.{スコープ名}.{操作タイプ}

可能なスコープ名（大文字と小文字を区別）	操作タイプ
候補者、求人オープニング、クライアント、部署、インタビュー、コンタクト、カスタム（すべてのカスタムモジュールに対して）	すべて - レコードへの完全なアクセス読み取り - モジュールからレコードを取得する

認証トークン認証のため

パラメータ	データ型	説明
authtoken*	String	暗号化された英数字文字列で、Zohoの資格情報を認証します。
スコープ*	文字列	値を指定してください recruitapi

リクエストパラメーター

パラメーター	データ型	説明
selectColumns	String	モジュール（オプションカラム）例：候補者（苗字、ウェブサイト、メール）またはすべて
fromIndex	整数	デフォルト値 - 1
toIndex	整数	デフォルト値 - 20 最大値 - 200
sortColumnString	文字列	「sortColumnString」を使用する場合、データはデフォルトで昇順で並べ替えられます。
sortOrderString	String	デフォルト値 - asc 降順で並べ替えを行う場合は、sortOrderString=descと指定してください。
最終更新時間	DateTime	デフォルト値：null 指定した時間以降に更新されたデータを取得します。
新しいフォーマット	整数	新しいフォーマット=1：Recruitアカウントからデータを挿入する際に、'null'値を含むフィールドを除外します。新しいフォーマット=2： Recruitアカウントからデータを挿入する際に、'null'値を含むフィールドを含めます。
バージョン	整数	バージョン=2: これは、最新のAPI実装に基づいて応答を取得します。バージョン=4: 1つのAPIメソッド呼び出しで複数のレコードを取得します。

注意: * でマークされたパラメーターは必須です

求人開放に関する特定のパラメーター

パラメーター

データ型

説明

公開URL

ブール値

値を「true」に設定すると、求人詳細URLと応募URLが取得できます。デフォルトでは、この値は「false」に設定されています。

注：求人URLは、求人が「ウェブサイトに掲載」に設定された場合にのみ表示されます。

エラーを捕捉する

Recruit APIは、Recruit とアプリケーション間のデータを同期する際に、プログラムのトラブルシューティングを容易にするために、独自のエラーコードを提供しています。さまざまなエラーコードと対応する定義について詳しく知りたい場合は、エラーコードを参照してください。

追加のノート

Zoho Recruitからデータを取得する場合、ユーザーのフィールドレベルのセキュリティ設定が適用されます。したがって、すべてのユーザーデータを取得するには、最高のロール（例：Recruiter Admin）とプロファイル（例：管理者）を使用してユーザーIDを使用してください。

fromIndexとtoIndexは任意のパラメータです。デフォルトでは、fromIndexは1、toIndexは20です。

sortColumnString と sortOrderString は、オプションパラメータです。

lastModifiedTimeパラメータの値は、yyyy-MM-dd HH:mm:ss形式で指定してください。

例

クライアント名（降順）で20から200までのJSON形式で全てのアカウントを取得する

URL形式：

https://recruit.zoho.com/recruit/private/json/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=recruitapi&fromIndex=20&toIndex=200&sortColumnString=Client Name&sortOrderString=desc&version=2

2008年5月27日00時00分以降に変更/作成されたXML形式ですべてのアカウントを取得する

URL形式:

https://recruit.zoho.com/recruit/private/xml/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=recruitapi&lastModifiedTime=2008-05-27 00:00:00&version=2

バージョンが2のカンディデートを取得する

下記のようなレスポンスが返されます：

<候補者>

<FL val='Last Name'>Gossling</FL>

<FL val='Email'>varunteja.ch+4@zohocorp.com</FL>

<FL val='Source'>Varun</FL>

</row>

</候補者>

新しいフォーマットパラメーターを指定せずに候補者を取得する

注意：レスポンス形式が指定されていない場合、新しいフォーマットパラメータにはデフォルト値「1」が割り当てられます。つまり、newFormat = 1となります。

URL 形式:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名, 姓, メールアドレス, 現在の会社, ソース, 電話番号, 市, 最高の学歴)&version=2

レスポンスは以下のようになります：

<候補者>
<row no='1'>
<FL val='候補者ID'>292147000000107425</FL><FL val='名'>エドウィン</FL><FL val='姓'>A</FL><FL val='メール'>edwinraj.p@gmail.com, edwinirudaya@yahoo.com</FL><FL val='電話'>+919884351702</FL><FL val='市'>パンマル</FL><FL val='現在の雇用主'>AVAcorp Technologies Pvt Ltd</FL><FL val='最高の学歴'>情報技術のB.Tech</FL><FL val='ソース'>パーサーによってインポートされた</FL>
</row>
</候補者>

新しいFormat=2を取得する

URLフォーマット：

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi
&newFormat=2&selectColumns=Candidates(Candidate Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Candidate Source,Candidate Status,No of Employees,Annual Revenue)

これは以下のようなレスポンスを返します：

<候補者>
<row no='1'>
<FL val='CANDIDATEID'>292147000000107430</FL><FL val='名'>ジョブ</FL><FL val='姓'>人を見つける</FL><FL val='メール'>null</FL><FL val='電話'>null</FL><FL val='市'>null</FL><FL val='現在の雇用主'>null</FL><FL val='最高の学歴'>null</FL><FL val='ソース'>パーサーによってインポートされた</FL>
</row>

</候補者>

fromIndex=1からtoIndex=25で呼び出す

URL の形式:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名, 姓, メール, 現在の会社, ソース, 電話, 都市, 最高の学歴)&version=2&fromIndex=1&toIndex=25

注：これは1から25のレコードを返します。

最終更新時間を使って通話する

URL 形式:

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名前,苗字,メールアドレス,現在の職場,ソース,電話,市,最高の学歴)lastModifiedTime=2010-04-21 11:09:23&version=2

注：時間を指定すると、構成された時間の後に変更されたデータが取得されます。

新しいFormat=1を持つ候補者からすべてのフィールドを選択する

URLフォーマット：

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi