B.2.1 リクエスト

メソッド: POST

機能パス: /regIDs

引数: なし

ヘッダー: Content-Type: application/json; charset=UTF-8

ボディ

以下の形式です。

{
    "pushKind":"プッシュ種別",
    "appName":"アプリケーション名",
    "sandboxFlag":"サンドボックスフラグ",
    "getExtFlag":"拡張データ通知",
    "offset":"取得開始件数",
    "maxCount":"取得最大件数"
}

変数名	説明	省略可否	型	指定値、または例
pushKind	プッシュ種別	可	String	APNs、GCM、FJP 指定が省略された場合、全プッシュ種別を検索対象とする。
appName	アプリケーション名	不可	String	最大1024byte 半角英数字＋記号
sandboxFlag	サンドボックスフラグ。debug版かどうかを示す	可	boolean	登録IDにAPNsのデバイストークンが含まれる場合に有効デフォルト値:false true:sandbox版 false:release版
getExtFlag	拡張データ通知	可	boolean	デフォルト値:false true:拡張データも通知 false:登録IDのみ通知
offset	取得開始件数	可	int	1以上。デフォルト:1件目から
maxCount	取得最大件数	可	int	1以上。デフォルト: 定義ファイル(impush.properties)の同時指定可能な最大登録ID数(fj_push_max_num_for_address)

注意事項

取得開始件数が指定された場合は、検索条件に一致するデータのうち、取得開始件数以降のデータを返却します。検索結果が取得開始件数未満の場合、データは返却されません。
取得最大件数が指定された場合は、検索条件に一致するデータのうち、取得最大件数分のデータを返却します。指定値が０以下、または、定義ファイル(impush.properties)の同時指定可能な最大登録ID数(fj_push_max_num_for_address)を超えている場合はエラーとします。