候補者確認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概要ドキュメントのセクションを参照してください。

リクエストの例

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

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

回答例

以下は正常な応答の例です。申請された候補者IDが検証され、確認されます。CCWは、HTTP 200応答コードと候補者IDを含む応答を送信することで、確認が成功したことを示します。

{
    "id":"12345"
}

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

{   
 "error_code": "string",
 "error_summary": "string",
 "error_causes": [      
  {   
    "error_sub_code": "string", 
    "error_sub_code_desc": "string",
  }
 ]
}

エラーコード

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