エラーレスポンス

popinfo Management API が、リクエストを解釈し、エラーとなった場合は、ステータスコード200または429を返却し、レスポンスボディーにて、JSON形式でエラー情報が返されます。

キー名	型	説明
status	文字列	必ず NG の2文字が入ります。
error	オブジェクト	必ず含まれます。
error.code	文字列	EもしくはWから始まる 10文字以内の文字列が入ります。
error.message	文字列	日本語文字列にて、エラー内容が返されます。 この値は、予告なく変更される可能性があります。

※ エラーコードに関しては、本ドキュメント末尾をご覧ください。

エラーレスポンスの例

{
   "status": "NG",
   "error" {
      "code": "E00000",
      "message": "エラー内容の簡易な説明"
   }
}