ページネーションとリスト

このページでは、APIリクエストから返送されるオブジェクトのリスト構造について説明します。

リクエストのパラメータ

Parameter Value
from (任意, デフォルト: 1970-01-01T00:00:00Z, フォーマット: iso8601) 返される記録の開始を定める日付と時刻(UTC) E.g.: 2014-10-20T00:00:00Z
to (任意, デフォルト: 現在のUTC 日時, フォーマット: iso8601) 返される記録の終了を定める日付と時刻(UTC)
offset (任意, デフォルト: 0) 最初に返される記録のオフセット I.e.: 開始からスキップする記録の数
limit (任意, デフォルト: 20, 最大: 100) 返送記録の最大数
order (任意, デフォルト: 時系列) 返送リストの並び順. I.e.: chronological (古→新), reverse_chronological (新→古)

レスポンスのパラメータ

Parameter Value
object (string) オブジェクト名. 値は list です。
from (任意, デフォルト: 1970-01-01T00:00:00Z, フォーマット: iso8601) 返される記録の開始を定める日付と時刻(UTC) E.g.: 2014-10-20T00:00:00Z
to (任意, デフォルト: 現在のUTC 日時, フォーマット: iso8601) 返される記録の終了を定める日付と時刻(UTC)
offset (integer) 最初に返される記録のオフセット
limit (integer) 返送記録の最大数
total (integer) from から to までの返送記録の合計
data (array) 返信オブジェクトの整列 (charges, cards, ...)

カードリストのページネーション例は以下のとおりです。同様の形式がカードAPI、トランザクションAPIなど全てのリストに適用されます。 ページネーションのパラメータの活用については、ご自身の必要に応じてお好みのコンビネーションをお使いください。

curl https://api.omise.co/customers/cust_test_4xs68oo1vgalgffzsyw/cards \
  -X GET \
  -u skey_test_4xs68olyuul9lmmp375: \
  -d "from=2014-10-20T00:00:00Z" \
  -d "to=2014-10-25T00:00:00Z" \
  -d "offset=1" \
  -d "limit=5"
{
  "object": "list",
  "from": "2014-10-20T00:00:00Z",
  "to": "2014-10-25T00:00:00Z",
  "offset": 1,
  "limit": 5,
  "total": 2,
  "data": [
    {
      "object": "card",
      "id": "card_test_4xs68on6y9b4teqliza",
      "livemode": false,
      "location": "/customers/cust_test_4xs68oo1vgalgffzsyw/cards/card_4xs68on6y9b4teqliza",
      "country": "",
      "city": "Tokyo",
      "postal_code": "1510051",
      "financing": "",
      "last_digits": 4242,
      "brand": "Visa",
      "expiration_month": 10,
      "expiration_year": 2018,
      "fingerprint": "uBNb5Z5J6firoMoDo80jEc1X/QucKQ4SCu80kP9U0gE=",
      "name": "Masaharu Uno",
      "created": "2014-10-20T04:47:15Z"
    }
  ]
}