BeaconAPI

ビーコン管理APIは以下のメソッドを提供します。

getBeaconListメソッド

全てのビーコン端末情報を、リストで複数件取得します。

検索条件およびソート条件を指定して取得することも可能です。

RKZClient.getBeaconList(searchConditions, sortConditions, success, error);

searchConditions: Array RKZSearchConditionオブジェクトの配列

検索条件を指定します。
sortConditions: Array RKZSortConditionオブジェクトの配列

ソート条件を指定します。
success: function 成功時コールバック関数
```
function(datas) {
    // 成功時の処理
}
```
- datas: Array ビーコン端末情報オブジェクトの配列
error: function 失敗時のコールバック関数

全てのスポット情報を、リストで複数件取得します。

検索条件およびソート条件を指定して取得することも可能です。

RKZClient.getSpotList(searchConditions, sortConditions, success, error);

searchConditions: Array RKZSearchConditionオブジェクトの配列

検索条件を指定します。
sortConditions: Array RKZSortConditionオブジェクトの配列

ソート条件を指定します。
success: function 成功時コールバック関数
```
function(datas) {
    // 成功時の処理
}
```
- datas: Array スポット情報オブジェクトの配列
error: function 失敗時のコールバック関数

ユーザーのコンタクト情報にビーコン検知コンタクトを追加します。

RKZClient.addDetectBeaconContact(userAccessToken, beaconId, beaconSpotCode, rssi, detectBeaconDatetime, remarks, success, error);

userAccessToken: String ユーザーアクセストークン (必須)
beaconId: String ビーコンID (必須)
beaconSpotCode: String スポットコード (必須)
rssi: Number 検知電波強度 (必須)
detectBeaconDatetime: Date ビーコン検知日時 (必須)
remarks: String 備考
success: function 成功時コールバック関数
```
function(statusCode) {
    // 成功時の処理
}
```
- statusCode: String 正常終了のステータスコード
error: function 失敗時のコールバック関数

ユーザーのコンタクト情報からビーコン検知コンタクトを取得します。

検索条件およびソート条件を指定して取得することも可能です。

RKZClient.getDetectBeaconContact(userAccessToken, searchConditions, sortConditions, success, error);

userAccessToken: String ユーザーアクセストークン (必須)
searchConditions: Array RKZSearchConditionオブジェクトの配列

検索条件を指定します。
sortConditions: Array RKZSortConditionオブジェクトの配列

ソート条件を指定します。
success: function 成功時コールバック関数
```
function(datas) {
    // 成功時の処理
}
```
- datas: Array ビーコン検知コンタクト情報オブジェクトの配列
error: function 失敗時のコールバック関数

リファレンス