Setting

概要

スマートデバイスの各種設定状態の取得および設定機能を提供するプロファイル。

目次

API	概要
GET /gotapi/setting/date	スマートデバイスの日時を取得する。
PUT /gotapi/setting/date	スマートデバイスの日時の設定リクエストを送る。
GET /gotapi/setting/display/brightness	スマートデバイスのライト明度を取得する。
PUT /gotapi/setting/display/brightness	スマートデバイスのライト明度の設定リクエストを送る。
GET /gotapi/setting/display/sleep	スマートデバイスの画面消灯時間の設定値を取得する。
PUT /gotapi/setting/display/sleep	スマートデバイスの画面消灯設定リクエストを送る。
GET /gotapi/setting/sound/volume	スマートデバイスの音量を取得する。
PUT /gotapi/setting/sound/volume	スマートデバイスの音量の設定リクエストを送る。

GET /gotapi/setting/date

種別

one-shot

概要

スマートデバイスの日時を取得する。

デバイス側の日時の取り扱いがRFC3339になっていない場合は、 なるべくデバイスプラグイン側でRFC3339形式に変換するようにする。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	result	integer	Yes	0:正常応答 0以外:異常応答
システム名	product	string	Yes	DeviceConnectシステムの名前。
システムバージョン	version	string	Yes	DeviceConnectシステムのバージョン名。
署名	hmac	string	No	レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
日付	date	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。 例: 2015-05-17T10:02:20+09:00

レスポンスサンプル

{
"result" : 0,
"product" : "Example System",
"version" : "1.0.0",
"date" : "2015-05-17T10:02:20+09:00"
}

PUT /gotapi/setting/date

種別

one-shot

概要

スマートデバイスの日時の設定リクエストを送る。

デバイス側の日時の取り扱いがRFC3339になっていない場合は、 なるべくデバイスプラグイン側でRFC3339形式に変換するようにする。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
date	dateTime	Yes	RFC3339「yyyy-MM-dd'T'HH:mm:ssZZZZZ」の形式の日付。 例: 2015-05-17T10:02:20+09:00

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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"
}

GET /gotapi/setting/display/brightness

種別

one-shot

概要

スマートデバイスのライト明度を取得する。

明度については、デバイスプラグイン側で0.0〜1.0の値をデバイスに合う値に変換すること。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/setting/display/brightness

種別

one-shot

概要

スマートデバイスのライト明度の設定リクエストを送る。

明度については、デバイスプラグイン側で0.0〜1.0の値をデバイスに合う値に変換すること。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
level	float	Yes	ディスプレイの輝度を割合で示す 範囲 (0.0 <= level <= 1.0)

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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"
}

GET /gotapi/setting/display/sleep

種別

one-shot

概要

スマートデバイスの画面消灯時間の設定値を取得する。

消灯時間の単位はミリ秒とする。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/setting/display/sleep

種別

one-shot

概要

スマートデバイスの画面消灯設定リクエストを送る。

消灯時間の単位はミリ秒とする。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
time	long	Yes	ディスプレイが消灯するまでの時間 (ミリ秒)

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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"
}

GET /gotapi/setting/sound/volume

種別

one-shot

概要

スマートデバイスの音量を取得する。

音量値については、デバイスプラグイン側で0.0〜1.0の間に正規化を行うこと。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
kind	integer	Yes	|Value|Description| |:-----|:-----| |1|Alarm| |2|Voice Volume| |3|Ring Alert| |4|Incoming Mail Alert| |5|Media Player| |6|Other|

レスポンス

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

レスポンスサンプル

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

PUT /gotapi/setting/sound/volume

種別

one-shot

概要

スマートデバイスの音量の設定リクエストを送る。

音量値については、デバイスプラグイン側で0.0〜1.0の値をデバイスに合う値に変換すること。

リクエスト

物理名	データ型	必須	説明
serviceId	string	Yes	サービスID。
kind	integer	Yes	|Value|Description| |:-----|:-----| |1|Alarm| |2|Voice Volume| |3|Ring Alert| |4|Incoming Mail Alert| |5|Media Player| |6|Other|
level	float	Yes	音量を割合で示す。(0.0 <= level <= 1.0)

レスポンス

論理名	物理名	データ型	必須	説明
処理結果	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"
}