候補者検索API

CCWの候補者検索APIは、1つまたは複数のCCW申請書に提出された候補者に関するデータをクエリするために使用します。候補者の姓名、ステータス、確認する資格（派遣労働者として）などの検索基準は、CCW候補者検索APIを介して要求できます。特定のルックアップ基準に一致する候補データが返されます。

CCW候補者検索APIにアクセスするためのベースURLは次のとおりです。https ://<instance>/api/candidates/search

CCW APIの概要を参照して、CCW APIへのPOST要求の認証と送信方法を確認してください。リクエストには次の要素を含める必要があります。

申請ヘッダー

要求ヘッダーが認証に必要です。詳細については、CCWのAPI OverviewドキュメントのRequest Headersセクションを参照してください。

申請本文

メタオブジェクトとデータオブジェクトの両方をAPI要求本文に渡す必要があります。

メタ

メタデータセクションは、より速いパフォーマンスを確保するために返される結果の数を定義します。含まれるもの：

• 限度 ：1つのAPI要求で返される結果の最大数を1から50の間で定義します（つまり、ページ上の結果の数）
  • リミットの値が空であるか、50を超える場合、デフォルトは50結果になります
  • 制限の値が1未満の場合にエラーを返します
• 相殺 :要求が開始されるレコードを定義します。たとえば、limit = 30、offset = 51は、レコード51から始まる次の30レコードを返します。
  • オフセットの値が空の場合、デフォルトは0になります
  • オフセットの値が0未満の場合にエラーを返します。

データ

要求される1つ以上の特定のルックアップパラメータ（少なくとも1つの空でないパラメータを送信する必要があります）。

次の表は、候補ルックアップAPI要求本文内で渡すことができるすべてのデータパラメーターを定義します。

例の要求

POST/api/candidate/search

ホスト: <CCW FQDN>

権限付与：ベアラー <token>

Accept: "application/json"

相関ID ：Z 098 Jth 56 Nkio 343 YY 1 vXt



{

    "meta ": {

        "limit ":" number ",

        "OFFSET ":" NUMBER "

    }

    "data ": {

        "id ":" number ",

        "number ":" string ",

        "FIRST_NAME ":"文字列",

        "LAST_NAME ":"文字列",

        "EMAIL ":"文字列",

        "ccw_id ":"番号",

        "STATUS ":"文字列",

        "EXTERNAL_REFERENCE_NUMBER ":"文字列",

        "requisition_number ":"文字列",

        "HIRING_MANAGER_FIRST_NAME ":"文字列",

        "hiring_manager_last_name ":"文字列",

        "onboarding_eligibility_met ":"文字列",

        "CONFIRMATION_ELIGIBILITY_MET ":"文字列",

        "SUPPLIER_NAME ":"文字列"

    }

}

API回答

API要求本文で送信されたすべてのルックアップパラメーターに一致する候補が返されます。次の表は、成功したAPI要求へのCCWからの応答に候補に含まれる可能性のあるすべてのパラメータを定義しています。

回答例

以下は、少なくとも1人の応募者がルックアップ基準に一致した、成功した応答の例です。

メモ:

• total_count ： API要求の検索条件に一致した候補の 総数
• has_more ： trueまたはfalse。応答に含まれる応答に加えて、ルックアップ基準に一致する応募者が他にも存在するかどうかを示します

{

  "meta ": {

    "total_count ":1,

    "has_more ": false

  },

  "data ": [{

          "CANDIDATE ": {

             "id ": 622757,

             "number ":" CCW_CS_13897 ",

             "FIRST_NAME ":"セドリック",

             "LAST_NAME ":"ダニエルズ",

             "email ":" cedric.daniels@coupa.com ",

             "ccw_id ":" 23230203 ",

             "supplier ": {

                "id ": 526,

                "NAME ":"テストSupplier.Inc ",

                "number ":" 483735 ",

                "contact ": {

                    "FIRST_NAME ":"レスター",

                    "LAST_NAME ":"フリーマン",

                    "email ":" lester.freeman@supplierssample.com "

                }

             },

             "requisition ": {

                "id ":" 174011 ",

                "number ":" RS - REQ -27130 ",

                "TYPE ":"申請書を作成",

                "ジョブ_コード": "",

                "ジョブ_タイトル":"事務",

                "WORK_LOCATION_CODE ":" 04872 ",

                "WORK_LOCATION_NAME ":" 04872 - CRAFTSMAN CA ",

                "TYPE_OF_SERVICE ":"事務/専門職",

                "rate_type ":" 1時間あたり"

             },

             "hiring_manager_user_name ":"100DuChloe1.DuCollins1.1@coupadev.com ",

             "HIRING_MANAGER_FIRST_NAME ":"DuCollins1.1 ",

             "HIRING_MANAGER_LAST_NAME ":"100 DuChloe 1 ",

             "hiring_manager_email ":"100DuChloe1.DuCollins1.1@coupadev.com ",

             "ENGAGEMENT_TYPE ":"通常",

             "employment_type ":"1099 ",

             "status ":" wo - accepted ",

             "SUBMITTED_DATE ":"2020 -07 -28 T 14:36:22 Z ",

             "cw_number ":"RS - CW -059713 ",

             "number ":"RS - CS -0060176 ",

             "SHORT_LISTED ": false,

             "work_email ":"仕事のメール",

             "date_available ": null,

             "submitted_to_other_requirements ": false,

             "onboarding_status ":"開始",

             "onboarding_eligibility_met ":1,

             "confirmation_eligibility_met ": false,

             "statement_of_works ": [],

             "work_orders ": [

              {

                "id ": 224583,

                "number ":" RS - WO -059860 ",

                "ACTIVE ":" TRUE ",

                "CONTRACT_START_DATE ":" 2020 -07 -01 T 04:00:00 Z ",

                "CONTRACT_END_DATE ":" 2020 -12 -31 T 05:00:00 Z "

                "EXTERNAL_REFERENCE_NUMBER ":"外部参照番号"

              }

            ]

          }

        ],

        "meta ": {

        "total_count ":1,

        "has_more ": false

    }

}

以下は、応募者がルックアップ基準を満たしていない場合の応答例です。

{   

  "meta ": {     

    "total_count ":0,     

    "has_more ": false   

  },   

  "data ": [] 

}

有効な候補者ステータス

CCWのCandidate APIへのリクエストで渡される有効な候補者ステータス値は次のとおりです。

エラーコード

API要求が失敗すると、応答に次のいずれかのエラーコードが含まれます。