On This Page
REST API | Visa Platform Connect

ページネーション

レスポンスは、
リミット
および
オフセット
フィールドを含めてページネーションを示すことができます。
パラメータ
説明
limit
1 つのリクエストに戻すことができるアイテムの最大数を制御します。デフォルトは 20 です: 最大は 100 です。
100 以上にリミットを設定している場合、以下のエラーとなります。
Http Status: 400 Bad Request
Body
{
  "errors": [
    {
      "type": "invalidParameters",
      "message": "Invalid parameter values",
      "details": [
        {
          "name": "limit"
        }
      ]
    }
  ]
}
offset
結果の回収内で開始点を制御します。
0
 をデフォルトに設定します。
原点オフセットの設定は、回収において最初のアイテムを検索します。
例えば、ソースから検索された 15 アイテムを回収し、
limit=5
 を特定する場合、オフセット値を変更することで 3 つの連続したリクエスト内で完全な一連の結果を検索できます。
offset=0
、
offset=5
と
offset=10
.
結果数より大きなオフセットは、埋め込みオブジェクトを戻しません。

ページネーションレスポンスヘッダー

ヘッダー
説明
X-total-count
ページネーションに関わらず、記録数の合計を戻します。

ページネーションレスポンスボディフィールド

フィールド
説明
"object":"collection"
レスポンスがオブジェクトの回収であることを示します。
"offset": 40
リクエストで使用されるオフセットパラメータ
"limit": 20
リクエストで使用されるリミットパラメータ
"count": 20
戻されたオブジェクト数
"total": 87
オブジェクトの総数

例

ページネーションの例 1
この例は、41 から 60 のオブジェクトのリクエストを示します。
リクエスト
GET 
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=40&limit=20
インドの加盟店については、本番のエンドポイントは
https://api.in.cybersource.com/
 です。
IMPORTANT
  • 最初の回収にいる場合、その前のリンクは含まれません。
  • 最初の回収にいる場合、次のリンクは含まれません。
  • その他すべてのリンクは常に含まれます。例えば、1 つ結果の回収のみがある場合、
    self
    、
    first
    、と 
    last
     リンクの URL は同じです。
レスポンス
{
  "_links": {
    "self": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=40&limit=20"
    },
    "first": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=0&limit=20"
    },
    "prev": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=20&limit=20"
    },
    "next": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=60&limit=20"
    },
    "last": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=80&limit=20"
    }
  },
  "object":"collection",
  "offset": 40,
  "limit": 20,
  "count": 20,
  "total": 87,
  "_embedded": {
    <array data>
  }
}
ページネーションの例 2 - リミット関係へのオフセット
この例は、合計 8 のオブジェクトから 3 から 6 のオブジェクトのリクエストを示します。
以下の例は、2 番目の結果一式を示し、ユーザの元のリミットパラメータ値を変更しない前のページのリンクを強調します。
これは、オブジェクト 0 ～ 3 を含む前の回収を意味し、そのため回収 1 および 回収 2 の両方がオブジェクト 3 を含みます。
リクエスト
GET 
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=3&limit=4

Figure:

リミット関係へのオフセット
レスポンス
{
  "_links": {
    "self": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=3&limit=4"
    },
    "first": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=0&limit=4"
    },
    "prev": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=0&limit=4"
    },
    "next": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=7&limit=4"
    },
    "last": {
      "href": "
https://api.cybersource.com
/tms/v1/instrumentidentifiers/5BAAD18F8091052CE0539399D30AAB2F/paymentinstruments?offset=7&limit=4"
    }
  },
  "object":"collection",
  "offset": 3,
  "limit": 4,
  "count": 4,
  "total": 8,
  "_embedded": {
    <array data>
  }
}