エラー情報
リクエスト内容もしくはサーバでの処理中にエラーが発生した場合にはエラーレスポンスを返します。
エラーの種類は HTTP のレスポンスステータスコードで判別し、詳細はレスポンスボディの文字列で識別してください。
ステータスコードの400番台はクライアントエラーで、500番台はサーバエラーとなります。
以下に記載の内容は、返却されるエラーの一例です。
エラーハンドリングされる場合は、ステータスコードをもとにご対応ください。
アプリケーションから返すエラー
リクエストパスが不正な場合
HTTP レスポンスステータスコード: 400
{
"status_code": 400,
"message": "This request path is invalid"
}
リクエストパラメータの組み合わせが不正な場合
HTTP レスポンスステータスコード: 400
{
"status_code": 400,
"message": "This request parameter is invalid"
}
リクエストパラメータの値が不正な場合
HTTP レスポンスステータスコード: 400
{
"status_code": 400,
"message": "This request parameter is invalid"
}
リクエスト API が不正な場合
HTTP レスポンスステータスコード: 400
{
"status_code": 400,
"message": "This API is invalid"
}
未契約のリクエストを送った場合
HTTP レスポンスステータスコード: 400
{
"status_code": 400,
"message": "bad usage on this contract"
}
認証に失敗した場合
HTTP レスポンスステータスコード: 401
{
"status_code": 401,
"message": "This client is invalid"
}
署名に誤りがある場合
HTTP レスポンスステータスコード: 401
{
"status_code": 401,
"message": "This signature is invalid"
}
HTTPメソッドが不正の場合(POSTでリクエストした場合)
HTTP レスポンスステータスコード: 405
{
"status_code": 405,
"message": "This http method is invalid: POST"
}
リクエスト長の上限を超えている場合
HTTP レスポンスステータスコード: 414
{
"status_code": 414,
"message": "URI too long."
}
ルート全体の定期券情報が存在しない場合
HTTP レスポンスステータスコード: 500
{
"status_code": 500,
"message": "no commuter pass information"
}
指定された条件に該当する経路が見つからない場合
HTTP レスポンスステータスコード: 500
{
"status_code": 500,
"message": "The specified route is not found."
}
指定された条件が距離制限を超えた場合
HTTP レスポンスステータスコード: 500
{
"status_code": 500,
"message": "This route does not observe the distance limit."
}
ルート関連の不整合が発生した場合
HTTP レスポンスステータスコード: 500
{
"status_code": 500,
"message": "internal error"
}
サーバ側で不整合が発生した場合
HTTP レスポンスステータスコード: 500
{
"status_code": 500,
"message": "server error"
}
サーバ側でアクセスを制限している場合
HTTP レスポンスステータスコード: 503
{
"status_code": 503,
"message": "server error"
}
トライアル利用の際、上記エラーが発生する場合がございます。
あらかじめご了承ください。
サーバ側でタイムアウトが発生した場合
HTTP レスポンスステータスコード: 504
{
"status_code": 504,
"message": "Endpoint request timed out"
}
サーバ側でタイムアウトが発生した場合(POST通信時)
HTTP レスポンスステータスコード: 504
{
"status_code": 504,
"message": "execution timeout"
}
サービス元から返るエラー
インフラストラクチャにクラウドを採用しているため、サービス元よりステータスコード、および、レスポンスボディの文字列が返る場合がございます。 主なエラーは以下のとおりです。
クライアント ID が不明な場合
HTTP レスポンスステータスコード: 403
{
"message": "Invalid CID"
}
一定時間内に大量のリクエストを送信した場合(レートリミット)
HTTP レスポンスステータスコード: 429
{
"message": "Too Many Requests"
}
WAF(ウェブアプリケーションファイアウォール)によりアクセスが遮断された場合
HTTP レスポンスステータスコード: 403
{
"message": "Forbidden"
}