レコードの取得

レコードの取得

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

目的

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

要求URL

XMLフォーマット。

JSONフォーマット。

メモ：タブとは、候補者、求人、クライアント、面接、連絡先、カスタムタブ1、カスタムタブ2、カスタムタブ3、カスタムタブ4、カスタムタブ5を指します。

OAuth認証の場合

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

スコープ

Scope=ZohoRecruit.modules.all
（または）
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
使用可能なスコープ名（大文字と小文字を区別）
操作の種類
candidate, jobopening, client, department, interview, contact & custom（すべてのカスタムタブ用）
ALL - データへのすべての権限
READ - タブからデータを取得

Authtoken認証の場合

パラメーター
 データの種類
 詳細
authtoken*
 文字列
 Zohoの認証情報の認証に使用する、暗号化済みの英数字文字列です。
scope*
 文字列
 値に recruitapi を指定します

要求パラメーター

パラメーター
 データ型
 詳細
selectColumns
 文字列
 タブ（オプションの項目）、例：候補者（姓、Webサイト、メール）またはすべて
fromIndex
 整数
 初期値 - 1
toIndex
 整数
 初期値 - 20
最大値 - 200
sortColumnString
 文字列
 sortColumnStringパラメーターを使用すると、標準では、データは昇順で並べ替えられます。
sortOrderString
 文字列
 初期値 - asc
降順で並べ替える場合は、sortOrderString=descを渡す必要があります。
lastModifiedTime
 日時
 初期値：null
時刻を指定すると、設定済みの時刻以降に修正されたデータが取得されます。
newFormat
 整数
 newFormat=1：Recruitのアカウントからデータを挿入する際に、「null」の値を持つ項目を除外します。
newFormat=2：Recruitのアカウントからデータを挿入する際に、「null」の値を持つ項目を含めます。
version
 整数

version=2：最新のAPI実装に基づいてレスポンスを取得します。

version=4：1回のAPIメソッド呼び出しで複数のレコードを取得します。
メモ：*が付いているパラメーターは必須です

求人固有のパラメーター

パラメーター
 データ型
 詳細
publishURL
 真偽値

値をtrueに設定すると、求人の詳細URLと応募URLを取得できます。初期値はfalseです。
 

メモ：求人URLは、求人がWebサイトで公開で公開されている場合にのみ表示されます。

エラーの確認

Recruit APIでは、Recruitとアプリケーション間でデータを同期する際にプログラムの問題を簡単にトラブルシューティングできるよう、一意のエラーコードが提供されます。各種エラーコードとその定義の詳細については、エラーコードを参照してください。

補足事項

Zoho Recruitからデータを取得する際は、ユーザーの項目別の権限設定が適用されます。そのため、すべてのユーザーデータを取得するには、最上位の役職（例：採用管理者）と権限（例：管理者）を持つユーザーIDを使用してください。
fromIndexとtoIndexはオプションのパラメーターです。初期値として、fromIndexは1、toIndexは20です。

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

lastModifiedTimeパラメーターの値は、yyyy-MM-dd HH:mm:ssフォーマットにする必要があります。

例

JSONフォーマットで、クライアント名の降順に並べ替え、20から200までのすべての取引先を取得するには 
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-05-27 00: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

version=2で候補者を取得するには

次のようなレスポンスが返されます。
<Candidates>
<row no='1'>
<FL val='CANDIDATEID'>292147000000219010</FL>
<FL val='First Name'>John</FL>
<FL val='Last Name'>Gossling</FL>
<FL val='Email'>johngosling@zmail.com</FL>
<FL val='Phone'>1234567890</FL>
<FL val='Source'>Added by User</FL>
</row>
</Candidates>
newFormatパラメーターを指定せずに候補者を取得するには
メモ：レスポンスフォーマットを指定しない場合、newFormatパラメーターには初期値「1」が割り当てられます。つまり、newFormat = 1です。
URLフォーマット。

次のようなレスポンスが返されます。
<Candidates>
<row no='1'>
<FL val='CANDIDATEID'>292147000000107425</FL><FL val='First Name'>John</FL><FL val='Last Name'>Doe</FL><FL val='Email'>jogndoe@zmail.com</FL><FL val='Phone'>555-555-5555</FL><FL val='City'>Austin</FL><FL val='Current Employer'>Avon Corp Inc</FL><FL val='Highest Qualification Held'>Bachelor of Sciences - Biology</FL><FL val='Source'>Added by User</FL>
</row>
</Candidates>
 newFormat=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)
以下のようなレスポンスが返されます。
<Candidates>
<row no='1'>
<FL val='CANDIDATEID'>292147000000107430</FL><FL val='First Name'>Jobs</FL><FL val='Last Name'>Find People</FL><FL val='Email'>null</FL><FL val='Phone'>null</FL><FL val='City'>null</FL><FL val='Current Employer'>null</FL><FL val='Highest Qualification Held'>null</FL><FL val='Source'>Imported by parser</FL>
</row>
</Candidates>
fromIndex=1、toIndex=25を指定して呼び出すには
URLフォーマット。

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)&version=2&fromIndex=1&toIndex=25
メモ：1～25件のデータが返されます。
lastModifiedTimeを指定して呼び出すには
URLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)lastModifiedTime=2010-04-21 11:09:23&version=2
メモ：時刻を指定すると、設定済みの時刻より後に修正されたデータが取得されます。
newFormat=1で候補者のすべての項目を選択するには

URLフォーマット。

&newFormat=1&selectColumns=All&version=2
メモ：値があるすべての項目が返されます。
newFormat=2で候補者のすべての項目を選択するには
URLフォーマット。

メモ：null値の項目を含む、すべての項目が返されます。
lastModifiedTime、fromIndex、toIndexを指定して呼び出すには
URLフォーマット。

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecords?authtoken=AuthToken&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)&lastModifiedTime=2010-04-21 11:09:23&fromIndex=1&toIndex=25&version=2