レスポンス

Content-Typeヘッダー

すべてのレスポンスはJSON形式で返されます。これはContent-Typeヘッダーを送信することで指定されます。

ステータスコード

以下は、現在サポートしているさまざまなリソースに対するステータスコードの説明を含む表です。

レスポンスコード	説明
200	OK
201	リソースが作成されました
202	受け入れられました
400	不正なリクエスト
401	認証されていません
404	リソースが見つかりません
406	受け入れ不可
422	処理できないエンティティ
429	リクエストが多すぎます
500	サーバ内部エラー

ページネーション

ページネーションクエリを使用してリクエストを行った場合、メタデータがレスポンスに含まれ、データセットの前のページ、現在のページ、最初のページ、および最後のページを簡単にトラバースすることができます。

{
    "data": [
        // レスポンスデータ
    ],
    "meta": {
        "total_pages": 100,
        "total_rows": 2000,
        "order": "DESC",
        "order_by": "resource_field",
        "limit": 20,
        "offset": 0,
        "next_key": ""
    }
}