共通レスポンス構造
| フィールド |
型 |
説明 |
| 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。各リクエストの状況を追跡するために使用します。 |
リクエスト JSON 形式エラーの例
{
"code": 400,
"content": {"reason": "Expecting value", "line": 1, "column": 10},
"errorCode": "ft.RequestJsonFormatError",
"message": "请求 JSON 格式错误",
"success": false,
"traceId": "TRACE-XXXX"
}