モジュールの取得

モジュールの取得

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

目的

getModulesメソッドを使用すると、Recruitのアカウント内のタブの一覧を取得できます。

リクエストURL

XMLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Info/getModules?authtoken=AuthToken&scope=recruitapi

JSONフォーマット。
https://recruit.zoho.com/recruit/private/json/Info/getModules?authtoken=AuthToken&scope=recruitapi

OAuth認証の場合

ヘッダー名

Authorization
Zoho-oauthtoken {access_token}

スコープ

Scope=ZohoRecruit.modules.all
(または)
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
指定可能なスコープ名(大文字と小文字を区別)
操作の種類
referral, campaign, assessment, vendor, offer, attachment,
forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom(すべてのカスタムタブ用
ALL - データへのすべての権限
READ - タブからデータを取得

Authtoken認証の場合

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

リクエストパラメーター

パラメーター データの種類 詳細
authtoken* 文字列 Zohoの認証情報の認証に使用する、暗号化済みの英数字の文字列です。
scope* 文字列 値にはrecruitapiを指定します。
version* 整数 使用する値はversion=2です。最新のAPI実装を基準にレスポンスを取得します。

メモ:*が付いているパラメーターは必須です。

レスポンスのサンプル

コードスニペット:
<response uri='/recruit/internal/xml/Info/getModules'>
<result>
<row no='1' id='xxxx000000002xxx' pl='Job Openings' sl='Job Opening' gt='1'>Job Openings</row>
<row no='2' id='xxxx000000002xxx' pl='Candidates' sl='Candidate' gt='1'>Candidates</row>
<row no='3' id='xxxx000000002xxx' pl='Interviews' sl='Interview' gt='1'>Interviews</row>
<row no='4' id='xxxx000000002xxx' pl='Clients' sl='Client' gt='1'>Clients</row>
<row no='5' id='xxxx000000002xxx' pl='Contacts' sl='Contact' gt='1'>Contacts</row>
<row no='6' id='xxxx000000002xxx' pl='ToDo's' sl='ToDo' gt='1'>ToDo's</row>
<row no='7' id='xxxx000000002xxx' pl='Emails' sl='Email' gt='1'>Emails</row>
<row no='8' id='xxxx000000002xxx' pl='Documents' sl='Documents' gt='1'>Documents</row>
<row no='9' id='xxxx000000002xxx' pl='Social' sl='Social' gt='1'>Social</row>
</result>
</response>