候補者確認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は、PUTメソッドでサポートされており、APIリクエストでその候補者の一意のIDのみを渡すことで、1人の候補者をCWとして確認します。明示的なリクエストは必要ありません。 以下の例では、「12345」が候補者検索API要求から取得された一意のIDです。
/api/candidates/12345/confirm HOST: <CCW FQDN> Authorization: Bearer <token> Accept: "application/json" Correlation - Id: Z 098 Jth 56 Nkio 343 YY 1 vXtレスポンスの例
以下は、成功したレスポンスの例です。 要求された候補者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リクエストの確認に失敗した場合、レスポンスには次のいずれかのエラーコードが含まれます。
HTTPステータスコード | エラーコード | エラーサブコード | エラーメッセージ |
|---|---|---|---|
400 | E4000000 | E4000001 | 不正なリクエストです。 必須のHTTPヘッダーが1つ以上欠落しています |
400 | E4000000 | E4000006 | 開始日を過去の日付に設定できません |
400 | E4000000 | E4000007 | 無効な開始日です |
400 | E4000000 | E4000008 | 終了日を開始日より後にしてください |
400 | E4000000 | E4000009 | 契約期間が <configured number of days/weeks/months/years> <days/weeks/months/years>の勤続年数要件を超えている |
400 | E4000000 | E4000010 | 無効なアカウント <account> |
400 | E4000000 | E4000012 | このCCW IDを持つ候補者または作業員はすでに存在します |
400 | E4000000 | E4000013 | 開始日を将来の日付に設定できません |
400 | E4000000 | E4000019 | タスク発注が無効です。 キャンセルされているか、非アクティブか、見つかりません |
400 | E4000000 | E4000020 | ワークパッケージが無効です。 キャンセルされているか、非アクティブか、見つかりません |
400 | E4000000 | E4000023 | 候補者が確認基準を満たしていません |
400 | E4000000 | E4000024 | 候補者はすでに確認済みです |
400 | E4000000 | E4000025 | OT給与レートは給与レート以上である必要があります |
400 | E4000000 | E4000026 | DOT給与レートはOT給与レート以上である必要があります |
400 | E4000000 | E4000027 | サプライヤーOT請求レートはサプライヤー請求レート以上である必要があります |
400 | E4000000 | E4000028 | サプライヤーDT請求レートはサプライヤーOT請求レート以上である必要があります |
400 | E4000000 | E4000029 | 最終OT請求レートは最終請求レート以上である必要があります |
400 | E4000000 | E4000030 | 最終DT請求レートは最終OT請求レート以上である必要があります |
400 | E4000000 | E4000031 | 請求レートは給与レート以上である必要があります |
400 | E4000000 | E4000032 | 最終請求レートはサプライヤー請求レート以上である必要があります |
400 | E4000000 | E4000033 | サプライヤーOT請求レートはOT給与レート以上である必要があります |
400 | E4000000 | E4000034 | 最終OT請求レートはサプライヤーOT請求レート以上である必要があります |
400 | E4000000 | E4000035 | サプライヤーDT請求レートはDT給与レート以上である必要があります |
400 | E4000000 | E4000036 | 最終DT請求レートはサプライヤーDT請求レート以上である必要があります |
400 | E4000000 | E4000037 | サプライヤー請求レートは最終請求レートと同一である必要があります |
400 | E4000000 | E4000038 | 申請書が閉じられているため、リクエストを完了できません |
400 | E4000000 | E4000039 | 申請書がキャンセルされたため、リクエストを完了できません |
401 | E4010000 | E4010001 | 認証に失敗しました. コンシューマー向けアプリに関連付けられている認証情報を確認してください |
401 | E4010000 | E4010002 | 認証に失敗しました. アクセストークンが無効または期限切れです |
403 | E4030000 | E4030001 | アクセス権がありません. ユーザーにはアクションを実行する権限がありません |
403 | E4030000 | E4030002 | アクセス権がありません. 無効な範囲です |
403 | E4030000 | E4030003 | アクセス権がありません. APIユーザーが無効です。 ユーザーがアクティブで、APIユーザーとして設定されていることを確認してください |
404 | E4040000 | E4040001 | 見つかりません |
405 | E4050000 | E4050001 | メソッドがサポートされていません。 サービスはリクエストされたHTTPメソッドをサポートしていません |
500 | E5000000 | E5000001 | システムまたはアプリケーションエラーが発生しました。Coupa CW管理者にお問い合わせください |