概要
グループを追加します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
エラーレスポンスのフィールド
概要
登録者グループのリストを表示します。デフォルトの順序はID の降順です。
リクエストアドレスの例
https://HOST:PORT/api/v1/group
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
data.dataフィールドの説明
エラーレスポンスのフィールド
概要
グループ ID に基づいてグループ内のすべての登録者のID のリストを取得します。
リクエストアドレスの例
https://HOST:PORT/api/v1/group/user
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
登録者グループを更新します。
v1 インターフェースを引き続きご利用いただくこともできます。詳細な手順については、過去のバージョンのマニュアルをご参照ください。
リクエストアドレスの例
https://HOST:PORT/api/v3/group/update
リクエスト方法
POST application/json
リクエストパラメーター
認証パラメーター
通常のレスポンス
レスポンスのフィールド
dataフィールドの説明
device フィールドの説明
エラーレスポンスのフィールド
概要
グループを削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/group/delete/{id}
リクエスト方法
GET
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
概要
登録者を一括でグループに追加します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/add/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスフィールドの説明
エラーレスポンスのフィールド
概要
グループから一括で登録者を削除します。
リクエストアドレスの例
http://HOST:PORT/api/v1/user/remove/group
リクエスト方法
POST: form-data
リクエストパラメーター
通常のレスポンス
レスポンスのフィールド
エラーレスポンスのフィールド
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
企業ID
create_at
string
作成時間
update_at
string
前回の変更時間
無効なパラメーターです。登録者グループ名はすでに存在します
50001
RPC FAILED
RPCに失敗しました。グループ作成に失敗しました
50002
Internal Server Error
内部システムエラーです。グループ作成に失敗しました
No
登録者グループタイプ。1：従業員、2：ビジター、5：拒否リスト
deviceId
long
No
デバイスの ID
groupIds
list<long>
No
グループID
app_key
string
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
ページサイズ
totalPage
string
ページ合計
data
object
データ
作成時間
update_at
string
更新時間
type
int
登録者グループタイプ
user_number
int
グループ内の人数
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
No
デバイスID リスト
Yes
タイムスタンプ
データ
デバイス
is_default
int
デフォルトのグループかどうかの識別
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
RPCに失敗しました。グループの削除に失敗しました
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
無効なパラメーターです。登録者の userId array が空です
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません
50001
RPC FAILED
RPCに失敗しました。一括登録者追加に失敗しました
Yes
Appキー
sign
string
Yes
シグネチャ。1.3.1 シグネチャ（sign）の計算の項を参照してください
timestamp
string
Yes
タイムスタンプ
無効なパラメーターです。登録者の userId array が空です
30001
param-invalid
無効なパラメーターです。登録者とグループタイプが一致しません
50001
RPC FAILED
RPCに失敗しました。グループからの登録者の一括削除に失敗しました
パラメーター名
型
必須
説明
name
string
Yes
グループ名。長さ制限は 45
type
int
Yes
グループタイプ（1 : 従業員グループ、2 : ビジターグループ、5 : 拒否リストグループ）
app_key
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
id
long
グループID
name
string
グループ名
type
int
グループタイプ
company_id
code
メッセージ
エラーの説明
30001
Param Invalid
無効なパラメーターです。登録者グループ名の長さが無効です
30001
Param Invalid
無効なパラメーターです。登録者グループタイプは空にはできません
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です
30001
パラメーター名
型
必須
説明
page
int
No
ページ番号（デフォルトは 1 ）
size
int
No
1 ページあたりのデータ数（デフォルトは 20 ）
type
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
object
データ
パラメーター名
型
説明
total
string
総計
pageNum
string
ページ数
size
string
サイズ
pageSize
パラメーター名
型
説明
id
int
登録者グループの ID
name
string
登録者グループ名
company_id
int
企業 ID
create_at
code
メッセージ
説明
30001
Param Invalid
無効なパラメーターです。登録者グループタイプが無効です
30001
Param Invalid
無効なパラメーターです。デバイスが存在しません
50001
RPC FAILED
RPCに失敗しました。デバイスグループリストの取得に失敗しました
パラメーター名
型
必須
説明
id
long
Yes
グループID
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
data
list<long>
登録者ID
code
メッセージ
エラーの説明
620
Record non-existent Error
グループID が存在しません
30001
Param Invalid
無効なパラメーターです
パラメーター名
型
必須
説明
id
long
Yes
グループID
name
string
No
グループ名
device_ids
パラメーター名
型
必須
説明
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
グループ名
type
int
グループタイプ
devices
パラメーター名
型
説明
id
int
デバイスの ID
name
string
デバイス名
type
int
デバイスタイプ
code
メッセージ
説明
30001
Param Invalid
無効なグループ ID など
600
Sync Failed
リモートリクエストエラー
パラメーター名
型
必須
説明
id
long
Yes
登録者グループの ID
app_key
string
Yes
Appキー
sign
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します
message
string
リターンメッセージ
code
メッセージ
説明
20002
Permission Denied
操作権限がないため、デフォルトのグループを削除できません
30001
Param Invalid
無効なパラメーターです。グループID が存在しません
30001
Param Invalid
無効なパラメーターです。変更グループは企業に属しておりません
50001
パラメーター名
型
必須
説明
groupId
long
Yes
登録者グループの ID
userIds
list<long>
Yes
一括で追加する登録者ID。1回の操作で最大2000人を追加できます
app_key
パラメーター名
型
説明
code
int
リターンコード
message
string
リターンメッセージ
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2,000 を超える数を一度にグループに追加することはできません
30001
param-invalid
無効なパラメーターです。groupId が空です
30001
パラメーター名
型
必須
説明
groupId
long
Yes
従業員のグループID
userIds
list<long>
Yes
一括で削除する登録者のID。最大2,000 まで一括で操作できます。
app_key
パラメーター名
型
説明
code
int
リターンコード。200 はリクエストが成功したことを示します
message
string
リターンメッセージ
code
メッセージ
説明
620
Record non-existent Error
グループID が存在しません
30001
param-invalid
無効なパラメーターです。2,000 を超える数を一度にグループから削除することはできません
30001
param-invalid
無効なパラメーターです。groupId が空です
30001
string
long
Param Invalid
int
string
string
string
list<long>
string
object
list<device>
string
RPC FAILED
string
param-invalid
string
param-invalid
{
"code": 200,
"message": "OK",
"data": {
"id": 616,
"name": "太朗",
"type": 1,
"company_id": 58,
"create_at": "2018-08-07 18:37:32",
"update_at": "2018-08-07 18:37:32"
}
}{
"code": 200,
"message": "OK",
"data": {
"total": 5,
"pageNum": 1,
"size": 5,
"pageSize": 20,
"totalPage": 1,
"data": [
{
"id": 214,
"name": "Default group",
"type": 1,
"user_number": 1327,
"company_id": 58,
"create_at": "2018-05-28 17:31:32.0",
"update_at": "2018-05-28 17:31:32.0"
},
{
"id": 215,
"name": " Default group",
"type": 2,
"user_number": 0,
"company_id": 58,
"create_at": "2018-05-28 17:31:32.0",
"update_at": "2018-05-28 17:31:32.0"
},
{
"id": 226,
"name": "123",
"type": 1,
"user_number": 1543,
"company_id": 58,
"create_at": "2018-05-30 14:50:17.0",
"update_at": "2018-05-30 14:50:17.0"
},
{
"id": 231,
"name": "ccc",
"type": 1,
"user_number": 4,
"company_id": 58,
"create_at": "2018-06-04 21:52:45.0",
"update_at": "2018-06-04 21:52:53.0"
},
{
"id": 517,
"name": "Test",
"type": 1,
"user_number": 2,
"company_id": 58,
"create_at": "2018-07-02 21:14:41.0",
"update_at": "2018-07-02 21:14:41.0"
}
]
}
}{
"code": 200,
"message": "OK",
"data": [
1014,
1241,
2896,
5124,
5125,
5126,
5127
]
}{
"code": 200,
"message": "OK",
"desc": "",
"data": {
"id": 253,
"name": "zml2",
"type": 1,
"devices": [{
"id": 268,
"name": "q",
"type": 0
}],
"is_default": 0
}
}
{
"code": 200,
"message": "OK"
}
{
"code": 200,
"message": "OK"
}{
"code": 200,
"message": "OK"
}