レコードを取得する

レコードを取得する

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

目的

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

リクエストURL

XML 形式:

JSON 形式:

メモ:タブは、Candidates、Job Openings、Clients、Interviews、連絡先、CustomModule1、CustomModule2、CustomModule3、CustomModule4、およびCustomModule5を指します。

OAuth認証の場合

ヘッダー名
値
Authorization
Zoho-oauthtoken {access_token}

スコープ

Scope=ZohoRecruit.タブ.すべて
(または)
Scope=ZohoRecruit.タブ.{scope_name}.{operation_type}
利用可能なスコープ名（大文字小文字を区別）
操作タイプ
candidate、job opening、client、部署、interview、連絡先 & カスタム（すべて カスタム タブ用） )
すべて - データへのフルアクセス
READ - タブからデータを取得

Authtoken認証の場合

パラメーター
 データの種類
 説明
authtoken*
 文字列
 Zoho認証情報の認証に使用される暗号化された英数字文字列。
scope*
 文字列
 値としてrecruitapiを指定してください。

Request パラメーター

パラメーター
 データの種類
 説明
selectColumns
 String
 タブ（任意の列）、例：Candidates（姓、Webサイト、メール）または全て
fromIndex
 Integer
 初期値 - 1
toIndex
 整数
 初期値 - 20
最大値 - 200
sortColumnString
 文字列
 sortColumnStringパラメータを使用した場合、初期設定ではデータは昇順で並べ替えられます。
sortOrderString
 文字列
 初期値 - asc
降順で並べ替えたい場合は、sortOrderString=descを指定してください。
lastModifiedTime
 DateTime
 初期値: null
時間を指定すると、設定した時間以降に更新されたデータが取得されます。
newFormat
 Integer
 newFormat=1: データをRecruitアカウントから挿入する際、'null'値の項目を除外します。
newFormat=2: 'null'値の項目を含めてデータをRecruitアカウントから挿入します。
バージョン
 Integer

バージョン=2:最新のAPI実装に基づいてレスポンスが取得されます。

バージョン=4: 1回のAPIメソッド呼び出しで複数のデータを取得できます。
メモ: * が付いているパラメーターは必須です。

求人固有のパラメーター

パラメーター
 データの種類
 説明
publishURL
 Boolean

値を真に設定すると、Job 詳細 URLおよびJob 適用する URLを取得できます。初期設定ではこの値は無効です。
 

メモ: Job URLは、ジョブが公開 in Webサイト.で公開済みの場合のみ表示されます。

エラーのキャプチャ

Recruit APIは、データ同期時にプログラム内の問題を簡単にトラブルシュートできるよう、ユニークなエラーコードを提供しています。各エラーコードおよびその定義の詳細については、エラーコードをご参照ください。

追加メモ

Zoho Recruitからデータを取得する際、ユーザーの項目レベルのセキュリティ設定が適用されます。そのため、すべてのユーザーデータを取得する場合は、最上位の役割（例：Recruiter Admin）および権限（例：Administrator）を持つユーザーIDを使用してください。
fromIndexおよびtoIndexはオプションのパラメーターです。初期設定では、fromIndexは1、toIndexは20です。

sortColumnStringおよびsortOrderStringもオプションのパラメーターです。

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

例

Client名前で降順に並び替え、20から200までのすべての取引先をJSON形式で取得する場合  
URL形式：

https://recruit.Zoho.com/recruit/非公開/json/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=recruitapi&fromIndex=20&toIndex=200&sortColumnString=Client 名前&sortOrderString=desc&バージョン=2

2008-05-27 00:00:00以降に更新または作成されたすべての取引先をXML形式で取得する方法
URL 形式:

https://recruit.Zoho.com/recruit/非公開/xml/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=recruitapi&lastModifiedTime=2008-05-27 00:00:00&バージョン=2

バージョン=2で候補者を取得する方法

以下のようなレスポンスが返されます:


292147000000219010
John
Gossling
1234567890
ユーザーによって追加


newFormatパラメーターを指定せずに候補者を取得する場合
メモ: レスポンス形式についての指定がない場合、初期値「1」がnewFormatパラメーターに設定されます（newFormat = 1）。
URL 形式：

https://recruit.Zoho.com/recruit/非公開/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名,姓,メール,現在 Employer,データ元,電話番号,市区町村,最高 Qualification Held)&バージョン=2
以下のようなレスポンスが返されます：


292147000000107425 John Doe jogndoe@zmail。com 555-555-5555 Austin Avon Corp Inc Bachelor of Sciences - Biology Added by ユーザー

 newFormat=2 を使用して取得する場合
URL 形式：

https://recruit.Zoho.com/recruit/非公開/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi
&newFormat=2&selectColumns=Candidates(Candidate 担当者,名,姓,Company,役職,メール,電話番号,FAX,モバイル,Webサイト,Candidate データ元,Candidate ステータス,いいえ of 従業員,Annual 売上)
下記のようなレスポンスが返されます：


292147000000107430 Jobs Find People null null null null null Imported by parser

fromIndex=1, toIndex=25 を指定して取得する場合
URL 形式：

https://recruit.Zoho.com/recruit/非公開/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名,姓,メール,現在 Employer,データ元,電話番号,市区町村,最高 Qualification Held)&バージョン=2&fromIndex=1&toIndex=25
メモ: 1から25件のデータが返品されます。
lastModifiedTimeで通話するには
URL 形式:
https://recruit.Zoho.com/recruit/非公開/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名,姓,メール,現在 Employer,データ元,電話番号,市区町村,最高 Qualification Held）。lastModifiedTime=2010-04-21 11:09:23&バージョン=2
メモ: 時間を指定すると、指定した時間以降に更新されたデータが取得されます。
newFormat=1で候補者のすべての項目を選択するには

URL 形式:

&newFormat=1&selectColumns=すべて&バージョン=2
メモ: これは値があるすべての項目を返品します。
newFormat=2で候補者のすべての項目を選択するには
URL 形式:

メモ: これはnull値を含むすべての項目を返品します。
lastModifiedTime、fromIndex、toIndexを使って通話するには
URL 形式:

https://recruit.Zoho.com/recruit/非公開/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(名,姓,メール,現在 Employer,データ元,電話番号,市区町村,最高 Qualification Held)&lastModifiedTime=2010-04-21 11:09:23&fromIndex=1&toIndex=25&バージョン=2