IDによるレコード取得

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

目的

このメソッドを使用すると、データIDで個別のデータを取得できます。

リクエストURL

XMLフォーマット。

https://recruit.zoho.com/recruit/private/xml/Module/getRecordById?authtoken=AuthToken&scope=recruitapi&version=2&id=RecordID

JSONフォーマット。

https://recruit.zoho.com/recruit/private/json/Module/getRecordById?&authtoken=AuthToken&scope=recruitapi&version=2&id=RecordID

メモ：タブは、候補者、求人、クライアント、面接、連絡先、カスタムタブ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*	文字列	Zohoの認証情報を認証するための、暗号化済みの英数字文字列です。
scope*	文字列	値に recruitapiを指定します

リクエストパラメーター

パラメーター	データ型	詳細
id*	文字列	id：データの一意のIDを指定します。
newFormat	整数（1または2）	newFormat=1：Recruitのアカウントからデータを取得する際に、値が「null」の項目を除外します。newFormat=2：Recruitのアカウントからデータを取得する際に、値が「null」の項目を含めます。
version	整数	version = 2：最新のAPI実装に基づいてレスポンスを取得します。

メモ：*が付いたパラメーターは必須です。

求人固有のパラメーター

パラメーター	データの種類	詳細
publishURL	真偽値	値をtrueに設定すると、求人詳細URLと求人への応募URLを取得できます。標準では、この値はfalseです。

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

例

IDでデータを取得するには、

URLフォーマット：

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecordById?authtoken=Auth Token&scope=recruitapi&version=2&id=ID

newFormatパラメーターを指定せずに候補者を取得するには

メモ：レスポンスのフォーマットが指定されていない場合、newFormatパラメーターには初期値の「1」が割り当てられます（例：newFormat=1）。

URLフォーマット：

https://recruit.zoho.com/recruit/private/xml/Candidates/getRecordByIdauthtoken=AuthToken&scope=recruitapi&id=2000000022020&version=2&selectColumns=Candidates(FirstName,LastName,Email,Current Employer,Source,Phone)

サンプルレスポンス：

<Candidates>
<row no='1'>
<FL val='CANDIDATEID'>2000000022020</FL>
<FL val='SMOWNERID'>2000000018005</FL>
<FL val='Candidate Owner'>John</FL>
<FL val='Company'>Zillium</FL>
<FL val='First Name'>Scott</FL>
<FL val='Last Name'>James</FL>
<FL val='No of Employees'>10</FL>
<FL val='Annual Revenue'>1000.0</FL>
<FL val='SMCREATORID'>2000000016908</FL>
<FL val='Created By'>John</FL>
<FL val='Created Time'>2010-03-16 10:04:52</FL>
<FL val='Modified Time'>2010-03-16 10:04:52</FL>
</row>
</Candidates>