利用実績を検索する#
Description#
QueryStringに「対象年月」「サービスブランドコード」「受付ID」「検索レコード開始位置」「検索レコード終了位置」の任意項目を設定し、該当する利用実績を検索します。
Method#
GET
Request Header#
共通リクエストヘッダーを参照してください。
Argument#
Name | Type | Required | Length(Long/Decimalの場合はValue) | URI | Query String | Description |
---|---|---|---|---|---|---|
target_month | String | No | 6 | - | ○ | 対象年月 yyyyMM形式 |
service_brand_code | String | No | 10 | - | ○ | サービスブランドコード サービスブランドを一意に識別するコード |
receipt_code | String | No | 15 | - | ○ | 受付ID 利用実績ログの受付時期を特定するID |
start_position | Long | No | 1 ~ 999999999999999 |
- | ○ | 開始位置 範囲の開始位置 |
end_position | Long | No | 1 ~ 999999999999999 |
- | ○ | 終了位置 範囲の終了位置 |
sort_item1 | String | No | 1 ~ 40 |
- | ○ | ソート項目名1 |
sort1 | String | No | 1 | - | ○ | ソート順 |
sort_item2 | String | No | 1 ~ 40 |
- | ○ | ソート項目名2 |
sort2 | String | No | 1 | - | ○ | ソート順 |
sort_item3 | String | No | 1 ~ 40 |
- | ○ | ソート項目名3 |
sort3 | String | No | 1 | - | ○ | ソート順 |
sort_item4 | String | No | 1 ~ 40 |
- | ○ | ソート項目名4 |
sort4 | String | No | 1 | - | ○ | ソート順 |
sort_item5 | String | No | 1 ~ 40 |
- | ○ | ソート項目名5 |
sort5 | String | No | 1 | - | ○ | ソート順 |
URI#
/API/v2/api/userecordlist
Sample request uri#
/API/v2/api/userecordlist?target_month=201711 &sort_item1=receipt_code &sort1=1 &sort_item2=service_brand_code &sort2=0 &sort_item3=use_record_id &sort3=1
Parameters in request body#
なし
Return Codes#
Code | Description |
---|---|
200 | 正常終了 |
401 | 認証エラー |
403 | アクセス不可 |
404 | 対象なし |
500 | 業務不整合 |
Response Header#
特筆する返却値はありません。
Response Parameter#
共通仕様はこちらを参照してください。
- レスポンス(正常)
example#
Parameters#
- レスポンス(異常)
共通エラー情報を参照してください。