釈明提出可否確認

指定した釈明リクエストについて、現在の呼び出し元が釈明、一次レビュー、二次レビューを提出できるかを確認します。可能な場合は null、不可の場合は理由コードを文字列で返します。

必要な権限

MEMBER以上のロールが必要です。メールで送信された有効な釈明トークンを token パラメータに指定すると、未ログイン状態でも呼び出せます。

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/explanation-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890/explainable?type=EXPLANATION"

リクエストパラメータ

パスパラメータ

リクエスト本文パラメータ

正常応答

提出可能な場合、explainable フィールドは null です。

{
  "explainable": null
}

提出不可の場合、explainable フィールドに理由コードが文字列で返されます。

{
  "explainable": "after-expired-at"
}

• explainable (文字列): 理由コード。取り得る値は次のとおり。
  • request-not-found: 釈明リクエストが存在しない
  • already-closed: 既に完了したリクエスト
  • not-submitted: 一次レビュー段階にまだ達していない
  • already-submitted: 既に二次レビュー段階に進んでいる
  • in-review: レビュー進行中のため役職員は追加釈明を作成できない
  • before-created-at: リクエスト作成日時より前のため作成不可
  • after-expired-at: 期限を経過したため作成不可
  • invalid-session: トークンまたはセッションが無効
  • not-employee: 役職員情報が無いか、レビュアーに指定されていない
  • no-permission: レビュー権限不足
  • invalid-type: サポートされていない釈明種別

エラー応答

必須パラメータが不足している場合

HTTPステータスコード 400 応答

{
  "error_code": "null-argument",
  "error_msg": "guid should be not null"
}

識別子がGUID形式ではない場合

HTTPステータスコード 400 応答

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

権限がない、またはトークンが無効な場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}