共通レスポンス構造¶
| フィールド | 型 | 説明 |
|---|---|---|
| code | Number | レスポンスのステータスコード。以下の例は標準的な JSON レスポンスです。ダウンロードなどの API は各ページの説明に従ってください。 |
| content | String、Number、Array、Boolean、JSON | 返却されるデータ。具体的にどの型のデータが返されるかは、実際の API のビジネス内容によって異なります |
| pageInfo | JSON | API がページネーションを提供する場合に返されます。具体的な階層は各 API の説明に従ってください |
| pageInfo.count | Number | 現在のページのデータ件数 |
| pageInfo.pageIndex | Number | ページ番号 |
| pageInfo.pageSize | Number | 1 ページあたりのサイズ |
| pageInfo.totalCount | Number | 条件に一致する総データ件数 |
| errorCode | String | 返却されるエラーコード。空の場合はエラーがないことを示します |
| message | String | 返却されたエラーコードに対応する具体的な説明情報 |
| success | Boolean | API が成功したかどうか。成功の場合は true、失敗の場合は false |
| traceId | String | traceId。各リクエストの状況を追跡するために使用します |
成功時と失敗時のレスポンス例¶
成功時のレスポンス:
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-XXXX"
}
失敗時のレスポンス(リクエスト JSON 形式エラー):