Connection - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

スマートデバイスとのネットワーク接続情報を提供するAPI。

目次

API 概要
GET /gotapi/connection/ble スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。
PUT /gotapi/connection/ble スマートデバイスのBLE機能有効状態を有効に設定する。
DELETE /gotapi/connection/ble スマートデバイスのBLE機能有効状態を無効に設定する。
GET /gotapi/connection/bluetooth スマートデバイスのBluetooth機能有効状態(ON/OFF)を取得する。
PUT /gotapi/connection/bluetooth スマートデバイスのBluetooth機能有効状態を有効に設定する。
DELETE /gotapi/connection/bluetooth スマートデバイスのBluetooth機能有効状態を無効に設定する。
PUT /gotapi/connection/bluetooth/discoverable スマートデバイスのBluetooth検索可能状態を有効に設定する。
DELETE /gotapi/connection/bluetooth/discoverable スマートデバイスのBluetooth検索可能状態を無効に設定する。
GET /gotapi/connection/nfc スマートデバイスのNFC機能有効状態(ON/OFF)を取得する。
PUT /gotapi/connection/nfc スマートデバイスのNFC機能有効状態を有効に設定する。
DELETE /gotapi/connection/nfc スマートデバイスのNFC機能有効状態を無効に設定する。
GET /gotapi/connection/onBleChange スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
PUT /gotapi/connection/onBleChange スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
DELETE /gotapi/connection/onBleChange スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
GET /gotapi/connection/onBluetoothChange スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
PUT /gotapi/connection/onBluetoothChange スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
DELETE /gotapi/connection/onBluetoothChange スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
GET /gotapi/connection/onNfcChange スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
PUT /gotapi/connection/onNfcChange スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
DELETE /gotapi/connection/onNfcChange スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
GET /gotapi/connection/onWifiChange スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。
PUT /gotapi/connection/onWifiChange スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。
DELETE /gotapi/connection/onWifiChange スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。
GET /gotapi/connection/wifi スマートデバイスのWIFI機能有効状態(ON/OFF)を取得する。
PUT /gotapi/connection/wifi スマートデバイスのWIFI機能有効状態を有効に設定する。
DELETE /gotapi/connection/wifi スマートデバイスのWIFI機能有効状態を無効に設定する。

種別

one-shot

概要

スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。

BLE機能有効状態取得をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
BLE有効状態 enable boolean Yes BLE機能有効状態。
ON : true
OFF : false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

種別

one-shot

概要

スマートデバイスのBLE機能有効状態を有効に設定する。

BLE機能有効状態の設定をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBLE機能有効状態を無効に設定する。

BLE機能有効の無効化をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBluetooth機能有効状態(ON/OFF)を取得する。

スマートデバイスでBluetooth機能有効状態がサポートされていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
Bluetooth機能有効状態 enable boolean Yes Bluetooth機能有効状態。
ON : true
OFF : false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

種別

one-shot

概要

スマートデバイスのBluetooth機能有効状態を有効に設定する。

スマートデバイスでBluetooth機能を有効にする機能がサポートされていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBluetooth機能有効状態を無効に設定する。

スマートデバイスでBluetooth機能有効状態を無効に設定する機能が サポートされていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBluetooth検索可能状態を有効に設定する。

Bluetooth検索可能状態の有効がサポートされていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBluetooth検索可能状態を無効に設定する。

Bluetooth検索可能状態の無効がサポートされていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのNFC機能有効状態(ON/OFF)を取得する。

NFC機能有効状態が取得をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
NFC機能有効状態 enable boolean Yes NFC機能有効状態。
ON : true
OFF : false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

種別

one-shot

概要

スマートデバイスのNFC機能有効状態を有効に設定する。

NFC有効状態の有効設定をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのNFC機能有効状態を無効に設定する。

NFC有効状態の無効をサポートしていない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報 connectStatus object Yes
BLE機能有効状態 enable boolean Yes BLE機能有効状態
ON: true
OFF: false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
interval long No デバイスプラグインがイベントを送信する間隔。

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
接続情報 connectStatus object Yes
BLE機能有効状態 enable boolean Yes BLE機能有効状態
ON: true
OFF: false

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onblechange",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのBLE機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報 connectStatus object Yes
Bluetooth機能有効状態 enable boolean Yes Bluetooth機能有効状態
ON: true
OFF: false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
interval long No デバイスプラグインがイベントを送信する間隔。

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
接続情報 connectStatus object Yes
Bluetooth機能有効状態 enable boolean Yes Bluetooth機能有効状態
ON: true
OFF: false

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onbluetoothchange",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報 connectStatus object Yes
NFC機能有効状態 enable boolean Yes NFC機能有効状態
ON: true
OFF: false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
interval long No デバイスプラグインがイベントを送信する間隔。

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
接続情報 connectStatus object Yes
NFC機能有効状態 enable boolean Yes NFC機能有効状態
ON: true
OFF: false

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onnfcchange",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのNFC機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを取得する。

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
接続情報 connectStatus object Yes
WIFI機能有効状態 enable boolean Yes WIFI機能有効状態
ON: true
OFF: false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを開始する。

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス
interval long No デバイスプラグインがイベントを送信する間隔。

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

イベント

論理名 物理名 データ型 必須 説明
サービスID serviceId string Yes イベントを送信したサービスのID
プロファイル名 profile string Yes プロファイル名。
インターフェース名 interface string Yes インターフェース名。
アトリビュート名 attribute string Yes アトリビュート名。
接続情報 connectStatus object Yes
WIFI機能有効状態 enable boolean Yes WIFI機能有効状態
ON: true
OFF: false

イベントサンプル

{
  "serviceId" : "Host.exampleId.localhost.deviceconnect.org",
  "profile" : "connect",
  "attribute" : "onwifichange",
  "connectStatus" : {
    "enable" : true
  }
}

種別

event

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化を通知するイベントを停止する。

WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)を取得する。

スマートデバイスのWIFI機能有効状態が取得できない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
WIFI機能有効状態 enable boolean Yes WIFI機能有効状態。
ON : true
OFF : false

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "enable" : true
}

種別

one-shot

概要

スマートデバイスのWIFI機能有効状態を有効に設定する。

スマートデバイスのWIFI機能有効状態が変更できない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

種別

one-shot

概要

スマートデバイスのWIFI機能有効状態を無効に設定する。

スマートデバイスのWIFI機能無効状態が変更できない場合はエラーを返す。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0: 正常応答
0以外: 異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
⚠️ **GitHub.com Fallback** ⚠️