各種APIのQUERY PARAMETERSについて
例えば会員一覧取得APIで、QUERY PARAMETERSの「fields」に「検索パラメータ」という記述がありますが、
これは会員情報の特定の項目に対して文字列や条件を指定し、それに合致する会員のみにフィルタすることができる、という意味でしょうか?
もしそうであれば、APIリクエストの記述方法をご教示いただけますでしょうか。
例えば会員一覧取得APIで、QUERY PARAMETERSの「fields」に「検索パラメータ」という記述がありますが、
これは会員情報の特定の項目に対して文字列や条件を指定し、それに合致する会員のみにフィルタすることができる、という意味でしょうか?
もしそうであれば、APIリクエストの記述方法をご教示いただけますでしょうか。
答え
@中島 佑太
「fields」は取得したい項目を指定する箇所となり、検索条件を指定できる箇所ではございません。
条件に一致した会員のみを抽出したい場合は、QUERY PARAMETERSに記載のある以下の項目のみ指定可能です。
◎項目
customer_code(会員コード)
customer_id-from(会員ID(From))
customer_id-to(会員ID(To))
customer_no(会員番号)
upd_date_time-from(更新日時(From))
upd_date_time-to(更新日時(To))
例えば、fields=customerIdでコールすると「customerId」項目のみを取得する意味合いとなります。
以下のようなレスポンスが返却され、その他の項目を取得できなくなります。
◎レスポンス例
[
{
"customerId": "1"
},
{
"customerId": "2"
},
{
"customerId": "3"
},
・・・