2.7 アクセスルールAPI

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

name

string

Yes

タイムテーブルの名前

monday_period

list<time>

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

特別な祝日

Time フィールドの説明

パラメーター名

型

必須

説明

start_time

string

Yes

00:00:00 形式

end_time

string

Yes

00:00:00 形式

Special_day フィールドの説明

パラメーター名

型

必須

説明

date

string

Yes

日付

remark

string

No

特記事項

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

ID

name

string

タイムテーブルの名前

monday

string

30分ごとのおおまかな 24 時間のアクセスルール

tuesday

string

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

タイムスタンプ（ミリ秒単位）

update_at

string

更新時間（使用できません）

special_days

list<special_day>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:00:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

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

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

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

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

610

Similar record Exist

タイムテーブルはアクセスルールに連携されているため、削除できません

620

Record non-existent Error

タイムテーブルが存在しません

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

id

int

Yes

タイムテーブルの ID

name

string

Yes

タイムテーブルの名前

monday_period

list<time>

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

特別な祝日

time フィールドの説明

パラメーター名

型

必須

説明

start_time

string

Yes

00:00:00 形式

end_time

string

Yes

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

必須

説明

date

string

Yes

日付

remark

string

No

特記事項

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

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

string

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>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

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

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

タイムテーブルの ID

name

string

タイムテーブル名

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

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

integer

タイムテーブルの ID

name

string

タイムテーブルの名前

monday

string

30分ごとのおおまかな 24 時間のアクセスルール

tuesday

string

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>

特別な日

time フィールドの説明

パラメーター名

型

説明

start_time

string

00:00:00 形式

end_time

string

00:30:00 形式

special_day フィールドの説明

パラメーター名

型

説明

id

int

特別な日の ID

date

string

日付。0000 は毎年を示し、2019 は特定の年に一度だけ有効であることを示します

remark

string

特記事項

timetable_id

int

タイムテーブルの ID

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

code

メッセージ

説明

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

POST application/json

リクエストパラメーター

パラメーター名

型

必須

説明

list<passRule>

Yes

アクセスルールのパラメーター

passRule フィールドの説明

パラメーター名

型

必須

説明

device_id

long

Yes

デバイスの ID

group_id

long

Yes

グループID

timetable_id

long

Yes

タイムテーブルの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

long

アクセスルールの ID

device_id

long

デバイスの ID

device_name

string

デバイス名

group_id

long

グループID

group_name

string

グループ名

group_type

int

グループタイプ

timetable_id

long

タイムテーブルの ID

timetable_name

string

タイムテーブル名

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

コード

メッセージ

説明

600

Sync Failed

RPCに失敗しました

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

ids

list<long>

Yes

アクセスルール ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

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

コード

メッセージ

説明

30001

Param Invalid

パラメーターエラー

620

Record non-existent Error

レコードが存在しません。

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

id

int

アクセスルール ID

device_id

int

デバイスの ID

device_name

string

デバイス名

group_id

int

アクセスグループ ID

group_name

string

アクセスグループ名

timetable_id

int

タイムテーブルの ID

timetable_name

string

タイムテーブル名

group_type

int

グループタイプ

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

コード

メッセージ

説明

30001

Param Invalid

パラメーターエラー

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

概要

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

リクエストアドレスの例

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

リクエスト方法

GET

リクエストパラメーター

パラメーター名

型

必須

説明

device_ids

list<long>

Yes

デバイスの ID

認証パラメーター

パラメーター名

型

必須

説明

app_key

string

Yes

Appキー

sign

string

Yes

timestamp

string

Yes

タイムスタンプ

通常のレスポンス

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

レスポンスのフィールド

パラメーター名

型

説明

code

int

リターンコード

message

string

リターンメッセージ

desc

string

リターンの説明

data

object

データ

dataフィールドの説明

パラメーター名

型

説明

device_id

int

デバイスの ID

device_name

string

デバイス名

timetable_groups

list<timetableGroup>

連携されているタイムテーブルとアクセスグループ

timetableGroup フィールドの説明

パラメーター名

型

説明

group_id

int

アクセスグループ ID

group_name

string

アクセスグループ名

group_type

int

グループタイプ

timetable_id

int

タイムテーブルの ID

timetable_name

string

タイムテーブル名

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

コード

メッセージ

説明

30001

Param Invalid

パラメーターエラー

60001

Device Not Exist

デバイスが存在しません

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

最終更新