コンテンツにスキップ

共通レスポンス構造


フィールド タイプ 説明
code Number 戻り値のステータスコードです。HTTP ステータスコードと同じで、エラーがない場合は 200 に固定されます。
content String、Number、Array、Boolean、JSON 返されるデータです。具体的なデータ型は、実際のインターフェースのビジネスロジックに依存します。
pageInfo JSON すべてのリストインターフェースのレスポンスに含まれるリストのページネーション情報です。
pageInfo.count Number 現在のページのデータ件数です。
pageInfo.pageIndex Number ページ番号です。
pageInfo.pageSize Number 1 ページあたりのサイズです。
pageInfo.totalCount Number 条件に一致する総データ件数です。
errorCode String エラーステータスコードです。空の場合はエラーなしを意味します。
message String エラーコードに対応する詳細な説明情報です。
success Boolean 固定で true です。インターフェースの呼び出しが成功したことを示します。
traceId Boolean traceId です。リクエストごとの追跡に使用します。

フィードバック

このページは役に立ちましたか?