2.7 アクセスルールAPI

2.7.1 タイムテーブルの追加 (/api/v3/pass/timetable)

概要

タイムテーブルを追加します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable

リクエスト方法

POST application/json

リクエストパラメーター

Time フィールドの説明

Special_day フィールドの説明

認証パラメーター

通常のレスポンス

{
 "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
 }

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.7.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

概要

タイムテーブルを削除します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.7.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

概要

タイムテーブルを更新します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/update

リクエスト方法

POST application/json

リクエストパラメーター

time フィールドの説明

special_day フィールドの説明

認証パラメーター

通常のレスポンス

{
 "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
 }
}

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.7.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

概要

タイムテーブルリストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": [{
 "id": 10,
 "name": "test1"
 }]
}

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.7.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

概要

タイムテーブルの詳細を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/timetable

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "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
 }
}

レスポンスのフィールド

dataフィールドの説明

time フィールドの説明

special_day フィールドの説明

エラーレスポンスのフィールド

2.7.6 アクセスルールの追加 (/api/v3/pass/rule)

概要

アクセスルールを追加します。一括追加をサポートします。最初にデバイスをグループに連携する必要があります。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule

リクエスト方法

POST application/json

リクエストパラメーター

passRule フィールドの説明

認証パラメーター

通常のレスポンス

{
    "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
    }]
}

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.7.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

概要

アクセスルールを削除します。一括削除が可能です。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule/delete

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "code": 200,
 "message": "OK",
 "desc": "",
 "data": {}
}

レスポンスのフィールド

エラーレスポンスのフィールド

2.7.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

概要

構成されているアクセスルールのリストを取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/rule/list

リクエスト方法

GET

認証パラメーター

通常のレスポンス

{
 "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
 }]
}

レスポンスのフィールド

dataフィールドの説明

エラーレスポンスのフィールド

2.7.9 デバイスおよびグループの連携情報の取得（アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

概要

すべてのデバイスおよびグループの連携関係（アクセスルール情報を含む）を取得します。

リクエストアドレスの例

https://HOST:PORT/api/v3/pass/devices/passrules

リクエスト方法

GET

リクエストパラメーター

認証パラメーター

通常のレスポンス

{
 "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": ""
 }]
 }]
}

レスポンスのフィールド

dataフィールドの説明

timetableGroup フィールドの説明

エラーレスポンスのフィールド

前へ2.6 QRコードの API 次へ2.8 レコードの API

最終更新 3 年前

2.7.1 タイムテーブルの追加 (/api/v3/pass/timetable)

2.7.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

2.7.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

2.7.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

2.7.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

2.7.6 アクセスルールの追加 (/api/v3/pass/rule)

2.7.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

2.7.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

2.7.9 デバイスおよびグループの連携情報の取得 （アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

2.7.1 タイムテーブルの追加 (/api/v3/pass/timetable)

2.7.2 タイムテーブルの削除 (/api/v3/pass/timetable/delete)

2.7.3 タイムテーブルの更新 (/api/v3/pass/timetable/update)

2.7.4 タイムテーブルリストの取得 (/api/v3/pass/timetable/list)

2.7.5 タイムテーブルの詳細の取得 (/api/v3/pass/timetable)

2.7.6 アクセスルールの追加 (/api/v3/pass/rule)

2.7.7 アクセスルールの削除 (/api/v3/pass/rule/delete)

2.7.8 アクセスルールリストの取得 (/api/v3/pass/rule/list)

2.7.9 デバイスおよびグループの連携情報の取得 （アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

2.7.9 デバイスおよびグループの連携情報の取得（アクセスルール情報を含む） (/api/v3/pass/devices/passrules)

2.7.9 デバイスおよびグループの連携情報の取得（アクセスルール情報を含む） (/api/v3/pass/devices/passrules)