概要
タイムテーブルを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
POST application/json
リクエストパラメーター
Time フィールドの説明
Special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルを削除します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
タイムテーブルを更新します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/update
リクエスト方法
POST application/json
リクエストパラメーター
time フィールドの説明
special_day フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
タイムテーブルの詳細を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/timetable
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
time フィールドの説明
special_day フィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule
リクエスト方法
POST application/json
リクエストパラメーター
passRule フィールドの説明
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
アクセスルールを削除します。一括削除が可能です。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/delete
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
構成されているアクセスルールのリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/rule/list
リクエスト方法
GET
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
すべてのデバイスおよびグループの連携関係 （アクセスルール情報を含む） を取得します。
リクエストアドレスの例
https://HOST:PORT/api/v3/pass/devices/passrules
リクエスト方法
GET
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
timetableGroup フィールドの説明
エラーレスポンスのフィールド
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
Yes
タイムスタンプ
データ
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
タイムスタンプ
データ
Yes
月曜日のアクセスルール
tuesday_period
list<time>
Yes
火曜日のアクセスルール
wednesday_period
list<time>
Yes
水曜日のアクセスルール
thursday_period
list<time>
Yes
木曜日のアクセスルール
friday_period
list<time>
Yes
金曜日のアクセスルール
saturday_period
list<time>
Yes
土曜日のアクセスルール
sunday_period
list<time>
Yes
日曜日のアクセスルール
holiday_period
list<time>
Yes
祝日のアクセスルール
start_timestamp
long
Yes
有効期限開始のタイムスタンプ
end_timestamp
long
Yes
有効期限終了のタイムスタンプ
special_days
list<special_day>
No
特別な祝日
Yes
タイムスタンプ
データ
24 時間のアクセスルール
wednesday
string
24 時間のアクセスルール
thursday
string
24 時間のアクセスルール
friday
string
24 時間のアクセスルール
saturday
string
24 時間のアクセスルール
sunday
string
24 時間のアクセスルール
holiday
string
24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
30分ごとのおおまかな 24 時間のアクセスルール
wednesday
string
30分ごとのおおまかな 24 時間のアクセスルール
thursday
string
30分ごとのおおまかな 24 時間のアクセスルール
friday
string
30分ごとのおおまかな 24 時間のアクセスルール
saturday
string
30分ごとのおおまかな 24 時間のアクセスルール
sunday
string
30分ごとのおおまかな 24 時間のアクセスルール
holiday
string
30分ごとのおおまかな 24 時間のアクセスルール
monday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
tuesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
wednesday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
thursday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
friday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
saturday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
sunday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
holiday_period
list<time>
アクセス時間（24時間形式、秒単位で指定）
start_timestamp
long
タイムスタンプ（ミリ秒単位）
end_timestamp
long
タイムスタンプ（ミリ秒単位）
special_days
list<special_day>
特別な日
タイムテーブルの ID
Yes
タイムテーブルの ID
Yes
タイムスタンプ
データ
グループID
group_name
string
グループ名
group_type
int
グループタイプ
timetable_id
long
タイムテーブルの ID
timetable_name
string
タイムテーブル名
Yes
タイムスタンプ
データ
Yes
タイムスタンプ
データ
アクセスグループ ID
group_name
string
アクセスグループ名
timetable_id
int
タイムテーブルの ID
timetable_name
string
タイムテーブル名
group_type
int
グループタイプ
Yes
タイムスタンプ
データ
タイムテーブルの ID
timetable_name
string
タイムテーブル名
パラメーター名
型
必須
説明
name
string
Yes
タイムテーブルの名前
monday_period
list<time>
Yes
月曜日のアクセスルール
tuesday_period
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
00:00:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
特記事項
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:00:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
610
Similar record Exist
タイムテーブルはアクセスルールに連携されているため、削除できません
620
Record non-existent Error
タイムテーブルが存在しません
パラメーター名
型
必須
説明
id
int
Yes
タイムテーブルの ID
name
string
Yes
タイムテーブルの名前
monday_period
パラメーター名
型
必須
説明
start_time
string
Yes
00:00:00 形式
end_time
string
Yes
00:30:00 形式
パラメーター名
型
必須
説明
date
string
Yes
日付
remark
string
No
特記事項
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
24 時間を 48 の期間に分割します。string は 0 と 1 で構成され、1 は該当する期間にアクセスが可能であることを示し、0 はアクセスが可能ではないことを示します。例：100000000000000000000000000000000000000000000001 は、00:00～00:30 を示し、23:30～24:00 はアクセス可能であることを示します
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
タイムテーブルの ID
name
string
タイムテーブル名
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
id
long
Yes
タイムテーブルの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
integer
タイムテーブルの ID
name
string
タイムテーブルの名前
monday
string
30分ごとのおおまかな 24 時間のアクセスルール
tuesday
パラメーター名
型
説明
start_time
string
00:00:00 形式
end_time
string
00:30:00 形式
パラメーター名
型
説明
id
int
特別な日の ID
date
string
日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します
remark
string
特記事項
timetable_id
code
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
list<passRule>
Yes
アクセスルールのパラメーター
パラメーター名
型
必須
説明
device_id
long
Yes
デバイスの ID
group_id
long
Yes
グループID
timetable_id
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
long
アクセスルールの ID
device_id
long
デバイスの ID
device_name
string
デバイス名
group_id
コード
メッセージ
説明
600
Sync Failed
RPCに失敗しました
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
ids
list<long>
Yes
アクセスルール ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
620
Record non-existent Error
レコードが存在しません。
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
id
int
アクセスルール ID
device_id
int
デバイスの ID
device_name
string
デバイス名
group_id
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
パラメーター名
型
必須
説明
device_ids
list<long>
Yes
デバイスの ID
パラメーター名
型
必須
説明
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
desc
string
リターンの説明
data
パラメーター名
型
説明
device_id
int
デバイスの ID
device_name
string
デバイス名
timetable_groups
list<timetableGroup>
連携されているタイムテーブルとアクセスグループ
パラメーター名
型
説明
group_id
int
アクセスグループ ID
group_name
string
アクセスグループ名
group_type
int
グループタイプ
timetable_id
コード
メッセージ
説明
30001
Param Invalid
パラメーターエラー
60001
Device Not Exist
デバイスが存在しません
list<time>
string
object
string
int
string
object
list<time>
string
object
string
int
string
object
string
object
string
int
long
string
object
long
string
object
string
object
int
string
object
int
{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 16,
"name": "test",
"monday": "100000000000000000000000111111111111111111111111",
"tuesday": "100000000000000000000000111111111111111111111111",
"wednesday": "100000000000000000000000111111111111111111111111",
"thursday": "100000000000000000000000111111111111111111111111",
"friday": "100000000000000000000000111111111111111111111111",
"saturday": "100000000000000000000000111111111111111111111111",
"sunday": "100000000000000000000000111111111111111111111111",
"holiday": "100000000000000000000000111111111111111111111111",
"special_days": [],
"monday_period": [{
"start_time": "0:00:00",
"end_time": "00:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"tuesday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"wednesday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"thursday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"friday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"saturday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"sunday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"holiday_period": [{
"start_time": "0:00:00",
"end_time": "0:29:59"
}, {
"start_time": "12:00:00",
"end_time": "23:59:59"
}],
"start_timestamp": 1576046318000,
"end_timestamp": 1576046318000
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"data": {
"id": 28,
"name": "test,
"monday": "010000000000000000000000000000000000000000000000",
"tuesday": "010000000000000000000000000000000000000000000000",
"wednesday": "010000000000000000000000000000000000000000000000",
"thursday": "010000000000000000000000000000000000000000000000",
"friday": "010000000000000000000000000000000000000000000000",
"saturday": "010000000000000000000000000000000000000000000000",
"sunday": "010000000000000000000000000000000000000000000000",
"holiday": "010000000000000000000000000000000000000000000000",
"special_days": [{
"id": 59,
"date": "2019-10-07",
"remark": null,
"timetable_id": 28
}, {
"id": 60,
"date": "0000-10-22",
"remark": null,
"timetable_id": 28
}],
"monday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"tuesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"wednesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"thursday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"friday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"saturday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"sunday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"holiday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"start_timestamp": 1546275661000,
"end_timestamp": 1546275661000
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 10,
"name": "test1"
}]
}{
"code": 200,
"message": "OK",
"data": {
"id": 28,
"name": "liufan1131",
"monday": "010000000000000000000000000000000000000000000000",
"tuesday": "010000000000000000000000000000000000000000000000",
"wednesday": "010000000000000000000000000000000000000000000000",
"thursday": "010000000000000000000000000000000000000000000000",
"friday": "010000000000000000000000000000000000000000000000",
"saturday": "010000000000000000000000000000000000000000000000",
"sunday": "010000000000000000000000000000000000000000000000",
"holiday": "010000000000000000000000000000000000000000000000",
"special_days": [{
"id": 59,
"date": "2019-10-07",
"remark": null,
"timetable_id": 28
}, {
"id": 60,
"date": "0000-10-22",
"remark": null,
"timetable_id": 28
}],
"monday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"tuesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"wednesday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"thursday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"friday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"saturday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"sunday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"holiday_period": [{
"start_time": "0:30:00",
"end_time": "0:59:00"
}],
"start_timestamp": 1546275661000,
"end_timestamp": 1546275661000
}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 141,
"device_id": 314,
"device_name": "v2.1.0-test4444",
"group_id": 2,
"group_name": "Default group",
"timetable_id": 35,
"timetable_name": "test-0713",
"group_type": 2
}]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {}
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"id": 141,
"device_id": 314,
"device_name": "v2.1.0-test4444",
"group_id": 2,
"group_name": "Default group",
"timetable_id": 35,
"timetable_name": "test-0713",
"group_type": 2
}]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": [{
"device_id": 9,
"device_name": "device6",
"timetable_groups": [{
"group_id": 476,
"group_name": "bbb",
"group_type": 2,
"timetable_id": 0,
"timetable_name": ""
}]
}]
}