Setting Profile

目次

API	機能概要
Volume Setting API GET	スマートデバイスの音量を取得する。
Volume Setting API PUT	スマートデバイスの音量の設定依頼を送る。
Date Setting API GET	スマートデバイスの日時を取得する。
Date Setting API PUT	スマートデバイスの日時の設定依頼を送る。
Display Light Setting API GET	スマートデバイスのライト明度を取得する。
Display Light Setting API PUT	スマートデバイスのライト明度の設定依頼を送る。
Display Sleep Setting API GET	スマートデバイスの画面消灯設定を取得する。
Display Sleep Setting API PUT	スマートデバイスの画面消灯設定依頼を送る。

機能概要

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

参考API

無し

Volume Setting API GET

インターフェース名称	Version	種別
Volume Setting API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
GET	/gotapi/setting/sound/volume

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
種別	kind	number	-	1=アラーム 2=通話音 3=電話着信音 4=メール着信音 5=メディアプレイヤーの音量 6=その他SNS等の着信音

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
音量	level	number	-	音量を割合で示す 範囲 (0.0 <= level <= 1.0)

リクエストサンプル

GET  http://localhost:4035/gotapi/setting/volume?serviceId=localhost.deviceconnect.org&kind=1&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "level":0.5
}

Volume Setting API PUT

インターフェース名称	Version	種別
Volume Setting API	2.0.0	同期I/F

概要

スマートデバイスの音量設定依頼を送る。

リクエスト

HTTPメソッド	URI
PUT	/gotapi/setting/sound/volume

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
種別	kind	number	-	1=アラーム 2=通話音 3=電話着信音 4=メール着信音 5=メディアプレイヤーの音量 6=その他SNS等の着信音
音量	level	number	-	音量を割合で示す 範囲 (0.0 <= level <= 1.0)

レスポンス

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/setting/volume

PUTデータ
serviceId=localhost.deviceconnect.org&kind=1&level=0.5&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

Date Setting API GET

インターフェース名称	Version	種別
Date Setting API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
GET	/gotapi/setting/date

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
日付	date	string	-	RFC 3339 例: "2014-01-01T00:00:00+0900"

リクエストサンプル

GET  http://localhost:4035/gotapi/setting/date?serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "date":"2014-05-05T01:01:01+0900"
}

Date Setting API PUT

インターフェース名称	Version	種別
Date Setting API	2.0.0	同期I/F

概要

スマートデバイスの日時の設定依頼を送る。

リクエスト

HTTPメソッド	URI
PUT	/gotapi/setting/date

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
日時	date	string	-	RFC 3339 例: "2014-01-01T00:00:00+0900"

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	0:正常応答 0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/setting/date				

PUTデータ
serviceId=localhost.deviceconnect.org&date=2014-05-05T01%3A01%3A01%2B090&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

Display Light Setting API GET

インターフェース名称	Version	種別
Display Light Setting API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
GET	/gotapi/setting/display/brightness

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
ライト明度	level	number	-	ライト明度を割合で示す 範囲 (0.0 <= level <= 1.0)

リクエストサンプル

GET  http://localhost:4035/gotapi/setting/brightness?serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "level":0.5
}

Display Light Setting API PUT

インターフェース名称	Version	種別
Display Light Setting API	2.0.0	同期I/F

概要

スマートデバイスのライト明度の設定依頼を送る。

リクエスト

HTTPメソッド	URI
PUT	/gotapi/setting/display/brightness

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
ライト明度	level	number	-	ライト明度を割合で示す 範囲 (0.0 <= level <= 1.0)

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/setting/ligh					

PUTデータ
serviceId=localhost.deviceconnect.org&level=0.4&accessToken=xxxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}

Display Sleep Setting API GET

インターフェース名称	Version	種別
Display Sleep Setting API	2.0.0	同期I/F

概要

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

リクエスト

HTTPメソッド	URI
GET	/gotapi/setting/display/sleep

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
消灯時間	time	number	-	消灯するまでの時間 (ミリ秒)

リクエストサンプル

GET  http://localhost:4035/gotapi/setting/brightness?serviceId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0,
    "time":30000
}

Display Sleep Setting API PUT

インターフェース名称	Version	種別
Display Sleep Setting API	2.0.0	同期I/F

概要

スマートデバイスの画面消灯設定依頼を送る。

リクエスト

HTTPメソッド	URI
PUT	/gotapi/setting/display/sleep

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象デバイス
設定値	time	number	-	消灯するまでの時間 (ミリ秒)

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

PUT  http://localhost:4035/gotapi/setting/brightness

PUTデータ
serviceId=localhost.deviceconnect.org&time=30000&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result":0
}