候補者検索API

CCWの候補者検索APIは、1つ以上のCCW申請書に提出された候補者に関するデータをクエリするために使用されます。候補者の名/姓、ステータス、確認すべき資格（臨時従業員として）などの検索基準は、CCW候補者検索APIを介して要求できます。特定の検索条件に一致する候補データが返されます。

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

詳細については、 CCW APIの概要 CCW APIへのPOSTリクエストを認証および送信する方法について説明します。申請には次の要素を含める必要があります。

リクエストヘッダー

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

申請本文

メタ および データ 両方のオブジェクトがAPIリクエスト本文で渡される必要があります。

メタ

メタデータセクションでは、パフォーマンスを向上させるために、返される結果の数を定義します。次を含む：

• 限度額 ：単一のAPIリクエストで返される結果の最大数を1から50の間で定義します（つまり、ページ上の結果の数）
  • リミットの値が空白か50より大きい場合、デフォルトは50結果です
  • Limitの値が1未満の場合はエラーを返します
• 相殺 ：リクエストを開始するレコードを定義します。例： limit=30, offset=51は、レコード51で始まる次の30レコードを返します。
  • の値の場合、デフォルトは0です 相殺 は空白です
  • の値が 相殺 は0未満です。

データ

要求する1つ以上の特定の検索パラメーター（少なくとも1つの空でないパラメーターを送信する必要があります）。

以下の表ではすべてを定義しています データ 候補者検索APIリクエストの本文内で渡すことができるパラメーター：

リクエストの例

POST /api/candidates/search
HOST: <CCW FQDN>
Authorization: Bearer <token>
Accept: "application/json"
Correlation-Id: Z098Jth56Nkio343YY1vXt

{
    "meta":{
        "limit":"number",
        "offset":"number"
    }
    "data":{
        "id":"number",
        "number":"string",
        "first_name":"string",
        "last_name":"string",
        "email":"string",
        "ccw_id":"number",
        "status":"string",
        "external_reference_number":"string",
        "requisition_number":"string",
        "hiring_manager_first_name":"string",
        "hiring_manager_last_name":"string",
        "onboarding_eligibility_met":"string",
        "confirmation_eligibility_met":"string",
        "supplier_name":"string"
    }
}

API応答

APIリクエスト本文で送信されたすべての検索パラメーターに一致する候補者が返されます。 次の表は、CCWから正常なAPIリクエストへの応答に候補に含まれる可能性があるすべてのパラメータを定義しています。

回答例

以下は、少なくとも1人の候補者が検索条件に一致した正常な回答の例です。

メモ:

• 合計カウント： apiリクエストの検索基準に一致した候補者の総数
• 詳細(_m): 真または偽。回答に含まれている候補に加えて、検索基準に一致する候補が他にもある場合に表示されます

{
  "meta": {
    "total_count": 1,
    "has_more": false
  },
  "data": [{
          "candidate":{
             "id":622757,
             "number":"CCW_CS_13897",
             "first_name":"Cedric",
             "last_name":"Daniels",
             "email":"cedric.daniels@coupa.com",
             "ccw_id":"23230203",
             "supplier":{
                "id":526,
                "name":"Test Supplier.Inc",
                "number":"483735",
                "contact": {
                    "first_name":"Lester",
                    "last_name":"Freeman",
                    "email":"lester.freeman@supplierssample.com"
                }
             },
             "requisition":{
                "id":"174011",
                "number":"RS-REQ-27130",
                "type":"Create Requisition",
                "job_code":"",
                "job_title":"Clerical",
                "work_location_code":"04872",
                "work_location_name":"04872-Craftsman CA",
                "type_of_service":"Clerical/Professional",
                "rate_type":"Per Hour"
             },
             "hiring_manager_user_name": "100DuChloe1.DuCollins1.1@coupadev.com",
             "hiring_manager_first_name": "DuCollins1.1",
             "hiring_manager_last_name": "100DuChloe1",
             "hiring_manager_email": "100DuChloe1.DuCollins1.1@coupadev.com",
             "engagement_type": "Regular",
             "employment_type": "1099",
             "status": "wo-accepted",
             "submitted_date": "2020-07-28T14:36:22Z",
             "cw_number": "RS-CW-059713",
             "number": "RS-CS-0060176",
             "short_listed": false,
             "work_email": "",
             "date_available": null,
             "submitted_to_other_requirements": false,
             "onboarding_status": "initiated",
             "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-01T04:00:00Z",
                "contract_end_date":"2020-12-31T05:00:00Z"
                "external_reference_number": ""
              }
            ]
          }
        ],
        "meta": {
        "total_count": 1,
        "has_more": false
    }
}

以下は、検索条件に一致する候補者がいない場合の回答の例です。

{   
  "meta": {     
    "total_count": 0,     
    "has_more": false   
  },   
  "data":[] 
}

有効な候補ステータス

以下は、リクエストでCCWの候補APIに渡すことができる有効な候補ステータス値です。

エラーコード

APIリクエストが失敗した場合、応答には次のいずれかのエラーコードが含まれます。