chunirec API v1.3 ドキュメント

Status: 200 OK

(応答内容は API メソッドによって異なります)

要求をサーバーが処理できない場合の応答です。追加情報が error.additional_message に格納される場合があります。

Status: 400 Bad Request

{
  "error": {
    "code": 400,
    "message": "bad request.",
    "additional_message": ""
  }
}

アクセストークンが無効の場合の応答です。

Status: 403 Forbidden

{
  "error": {
    "code": 403,
    "message": "invalid token.",
    "additional_message": ""
  }
}

要求された資源が見つからない場合の応答です。追加情報が error.additional_message に格納される場合があります。

Status: 404 Not Found

{
  "error": {
    "code": 404,
    "message": "not found.",
    "additional_message": ""
  }
}

API メソッドがリクエストメソッドに対応していない場合の応答です。

Status: 405 Method Not Allowed

{
  "error": {
    "code": 405,
    "message": "the requested method is not allowed.",
    "additional_message": ""
  }
}

リクエスト回数が上限に到達して一時的に要求を受け付けなくなった場合の応答です。

Status: 429 Too Many Requests

{
  "error": {
    "code": 429,
    "message": "too many requests.",
    "additional_message": ""
  }
}

メンテナンス中等でサービスが停止している場合の応答です。

Status: 503 Service Unavailable

{
  "error": {
    "code": 503,
    "message": "service unavailable.",
    "additional_message": ""
  }
}

API 応答