リリース日
2025年11月19日
機能紹介
会員リスト取得API(APIコード:02、API名称:getMemberList)について、検索結果の件数を取得する/しないを切り替える機能を追加。新たに「取得しない」という設定が可能となります。
管理画面の「設定 > システム設定」のメニューにて設定を変更できます。
(参考)■設定変更方法
【機能リリースの背景】
長年ご利用頂いているお客様では会員データ件数が百万件を超える状況となっており、会員リスト取得APIで検索を実行した際に、処理時間が増加しているケースが確認されております。
今回のリリースにより、データ量の増加により処理時間が増加する処理(件数を取得する処理)をスキップできるようになり、APIのレスポンス結果が表示されるまでの時間の改善を見込んでおります。
【APIの仕様変更点】
(1)検索結果を「取得する」設定の場合
会員リスト取得APIの取得件数制限(returnLimit)の仕様は下記の通りとなります。(既存の仕様から変更はございません)
・取得件数制限の指定がない場合
(A)「取得件数 ≦ 100」となっていたら、レスポンス値のStatusを「success」で返却します
(B)「取得件数 > 100」となっていたら、レスポンス値のStatusを「error」で返却します
※エラーメッセージは「該当する会員が100名存在します」というエラーとなります
・取得件数制限の指定がある場合
(A)「取得件数 ≦ 本リクエストパラメータ」となっていたら、レスポンス値のStatusを「success」で返却します
(B)「取得件数 > 本リクエストパラメータ」となっていたら、レスポンス値のStatusを「error」で返却します
※エラーメッセージは「該当する会員が●●名存在します」というエラーとなります。(「●●」部分は「本リクエストパラメータ」の値が入ります)
(2)検索結果を取得しない設定の場合
会員リスト取得APIの取得件数制限(returnLimit)の仕様は下記の通りとなります。(今回新しく追加される機能となります)
・取得件数制限の指定がない場合
(A)「取得件数 ≦ 100」となっていたら、レスポンス値のStatusを「success」で返却します
(B)「取得件数 > 100」となっていたら、レスポンス値のStatusを「success」で返却します
※(B)にてレスポンスされる会員情報については、会員IDの昇順でヒットする100件の会員情報のみがレスポンスされます。101件目以降はレスポンスされません。
・取得件数制限の指定がある場合
(A)「取得件数 ≦ 本リクエストパラメータ」となっていたら、レスポンス値のStatusを「success」で返却します
(B)「取得件数 > 本リクエストパラメータ」となっていたら、レスポンス値のStatusを「success」で返却します
※(B)にてレスポンスされる会員情報については、会員IDの昇順でヒットする●●件の会員情報のみがレスポンスされます。●●+1件目以降はレスポンスされません。(「●●」部分は「本リクエストパラメータ」の値が入ります)
| APIリクエスト | 条件 | (1)検索結果を取得する設定(既存仕様) | (2)検索結果を取得しない設定(新仕様) |
| 1. 取得件数制限 (returnLimit) の指定なし | (A) 取得件数 ≦ 100件 |
Status: success
・ 取得した全件の会員情報を返却します。 |
Status: success
・ 取得した全件の会員情報を返却します。 |
| (B) 取得件数 > 100件 |
Status: error
・ 会員情報は返却されません。
・ エラーメッセージ: 「該当する会員が100名存在します」 |
Status: success
・ 会員ID昇順で先頭100件の会員情報のみを返却します。
・ 101件目以降は返却されません。 |
|
| 2. 取得件数制限 (returnLimit) の指定あり | (A) 取得件数 ≦ returnLimit 指定件数 |
Status: success
・ 取得した全件の会員情報を返却します。 |
Status: success
・ 取得した全件の会員情報を返却します。 |
| (B) 取得件数 > returnLimit 指定件数 |
Status: error
・ 会員情報は返却されません。
・ エラーメッセージ: 「該当する会員が●●名存在します」(●●は returnLimit の値) |
Status: success
・ 会員ID昇順で returnLimit 指定件数の会員情報のみを返却します。
・ 指定件数+1件目以降は返却されません。 |
■設定変更方法
(1)CROSSPOINT管理画面の「設定 > システム設定」へアクセスします
(2)「編集」ボタンをクリックします
(3)「会員リスト取得APIでの件数取得」で「取得する」or「取得しない」を任意の設定を選択します
(4)「確認」ボタンをクリックします
(5)「更新」ボタンをクリックします