候補者確定API

CCW候補者確認APIは、サードパーティアプリケーションを介して候補者のオンボーディングアクティビティの一部またはすべてを管理し、候補者を派遣労働者（ CW ）として一度に1人ずつ確認するプロセスを自動化したい顧客向けに設計されています。APIは、要求で他のデータが渡されずに、単一の候補を確認する要求を処理できます。

CCW候補者検索APIを組み合わせて使用すると、確認に必要な基準を満たす候補者を見つけることができます。候補者確認APIは、各候補者を1つずつ確認することができます。

CCW候補者確認APIにアクセスするための基本URLは次のとおりです。https<instance> :// api/candidates<id> // confirm

CCW APIによって認証される方法については、CCW APIの概要を参照してください。リクエストには次の要素を含める必要があります。

ヘッダーを要求

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

例の要求

CCW候補者確認APIは、1人の候補者をCWとして確認するためのPUTメソッドによってサポートされています。これは、その候補者の一意のIDのみをAPIリクエストに渡し、明示的なリクエストボディは必要ありません。以下の例では、「12345」は候補者検索API要求から取得された一意のIDです。

/api/candidates/12345/confirmを入れる

ホスト: <CCW FQDN>

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

Accept: "application/json"

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

回答の例

以下は正解の例です。要求された応募者IDは検証され、確認されます。CCWは、HTTP 200応答コードと候補者IDを含む応答を送信することにより、確認が成功したことを示します。

{

    "id ":" 12345 "

}

次の例では、確認要求が失敗しました。該当するエラーメッセージとともに、HTTPエラーコードが返されます。

{   

 "error_code ":"文字列",

 "ERROR_SUMMARY ":"文字列",

 "error_causes ": [      

  {   

    "error_sub_code ":"文字列", 

    "ERROR_SUB_CODE_DESC ":"文字列",

  }

 ]

}

エラーコード

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