API (system developer)
ユーザー登録
ユーザー情報がJSON文字列で取得できます。
URL
https://md.moudee.co.jp/group_application_user_lists/index |
入力項目
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
APIキー | api_key | 必須 | 認証キー | 文字列 |
電話番号 | user_id | 任意 | 検索条件 | 数値 |
API結果
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
ユーザー情報 | users | 必須 | 取得データ | 配列 ※詳細は下記表を参照 |
ユーザー情報 ※検索でHITしたユーザー分だけ繰り替えされます。
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
登録日時 | created | 必須 | 取得データ | 日付形式(YYYY-MM-DD HH:ii:ss) |
会社名 | company_name | 必須 | 取得データ | 文字列 |
会員名 | user_name | 必須 | 取得データ | 文字列 |
電話番号 | user_id | 必須 | 取得データ | 数値 |
解錠端末 | terminal_flag | 必須 | 取得データ | 文字列 |
パターン | key_pattern | 必須 | 取得データ | 数値 |
パスワード | key_password | 必須 | 取得データ | 数値 |
メール | 必須 | 取得データ | 文字列 | |
ユーザー属性ID | user_attribute_id | 必須 | 取得データ | 数値 |
ユーザー属性名 | user_attribute_name | 必須 | 取得データ | 文字列 |
課金開始日 | display_user_attribute | 必須 | 取得データ | 日付形式(YYYY-MM-DD HH:ii:ss) |
エラーチェック
ステータス | メッセージ |
---|---|
E240000 | 入力値がありません |
E240101 | 接続許可が出ていない場所からの接続です |
E240201 | 鍵IDは必須項目です |
E240202 | 鍵IDは数値です |
E240203 | 鍵プランIDは数値です |
E240204 | 登録されていない鍵プランです |
E240205 | ユーザーが見つかりません |
E240301 | 鍵が存在しません |
E240302 | 鍵がすでに削除されています |
E240401 | データベースエラー |
E240501 | 認証エラーです |
ユーザー登録
ユーザー登録を行います。
URL
https://md.moudee.co.jp/group_application_user_deletes/index |
入力項目
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
APIキー | api_key | 必須 | 認証キー | 文字列 |
電話番号 | user_id | 必須 | 登録内容 | 数値 |
会社名 | company_name | 任意 | 登録内容 | 文字列 |
ユーザー名 | user_name | 任意 | 登録内容 | 文字列 |
解錠端末 | terminal_flag | 必須 | 登録内容 | 数値(0:タブレット, 1:スマホ) |
ユーザー属性 | user_attribute_id | 任意 | 登録内容 | 数値(ユーザー属性のID値指定) |
課金開始日 | account_start_date | 任意 | 登録内容 | 日付形式(YYYY-MM-DD or YYYY/MM/DD) |
戻り値
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
電話番号 | user_id | 必須※ | 登録した電話番号 | 数値 |
登録更新 | regist_flag | 必須※ | 登録結果 | 数値(0:更新, 1:登録) |
パターン | key_pattern | 任意 | ログインパターン | 数値 表示権限が有る場合のみ表示 |
パスワード | key_password | 任意 | ログインパスワード | 数値 表示権限が有る場合のみ表示 |
※正常終了時は必須
エラーチェック
ステータス | メッセージ |
---|---|
E260000 | 入力値がありません |
E260101 | 接続許可が出ていない場所からの接続です |
E260201 | 電話番号は必須項目です |
E260202 | 電話番号は数値です |
E260203 | 電話番号は20桁以内です |
E260301 | 名前は必須項目です |
E260302 | 名前は20文字以内です |
E260303 | 会社名は20文字以内です |
E260401 | 解錠端末は必須項目です |
E260402 | 解錠端末は0か1で入力してください |
E260403 | ユーザー属性は必須項目です |
E260404 | ユーザー属性は数値です |
E260405 | 課金開始日が年月日ではありません |
E260501 | ユーザーの保存に失敗しました |
E260502 | ユーザーの保存に失敗しました |
E260503 | ユーザーの保存に失敗しました |
E260504 | この電話番号はすでに登録されています |
E260505 | この名前はすでに登録されています |
E260506 | 認証エラーです |
ユーザー削除
ユーザー削除を行います。
URL
https://md.moudee.co.jp/group_application_user_deletes/index |
入力項目
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
APIキー | api_key | 必須 | 認証キー | 文字列 |
電話番号 | user_id | 必須 | 検索条件 | 数値 |
戻り値
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
エラーチェック
ステータス | メッセージ |
---|---|
E300000 | 入力値がありません |
E300101 | 接続許可が出ていない場所からの接続です |
E300201 | 電話番号は必須項目です |
E300202 | 電話番号は数値です |
E300301 | ユーザーが存在しません |
E300302 | ユーザーの削除に失敗しました |
E300303 | 鍵プラン登録の解除に失敗しました |
E300304 | ユーザーの削除に失敗しました |
E300401 | 認証エラーです |
解錠
解錠を行います。
URL
https://md.moudee.co.jp/group_application_unlocks/index |
入力項目
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
APIキー | api_key | 必須 | 認証キー | 文字列 |
MDO | mdo_id | 必須 | 対象のMDO | 数値(MDOのID値指定) |
戻り値
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
エラーチェック
Status | Message |
---|---|
E220000 | no input value |
E220101 | unauthenticated access attempt |
E220201 | MDO ID required |
E220202 | MDO ID is numeric |
E220301 | MDO ID is invaid |
E220401 | DoorRequest Table DB save failure |
E220402 | log Table DB save failure |
鍵登録
鍵の登録 もしくは 鍵プランの登録を行う。 同時に指定した場合は鍵プランの登録のみ行う。
鍵の登録の場合は開始時刻、終了時刻よりも無期限解錠の値を優先する。
URL
https://md.moudee.co.jp/group_application_key_regists/index |
入力項目
論理名 | 物理名 | 鍵登録時 | 鍵プラン登録時 | 備考 | 型 |
---|---|---|---|---|---|
APIキー | api_key | 必須 | 必須 | 認証キー | 文字列 |
電話番号 | user_id | 必須 | 必須 | 登録内容 | 数値 |
鍵プラン | key_plan_id | 任意 | 必須 | 登録内容 | 数値(鍵プランのID値指定) |
鍵プラン開始日 | plan_start_date | 任意 | 任意 | 登録内容 | 日付形式(YYYY-MM-DD or YYYY/MM/DD) |
MDO | mdo_id | 必須 | 任意 | 登録内容 | 数値(MDOのID値指定) |
開始時刻 | start_time | 必須※ | 任意 | 登録内容 | 日付形式(『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』) |
終了時刻 | end_time | 必須※ | 任意 | 登録内容 | 日付形式(『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』) |
無期限解錠 | unlimited_flag | 必須 | 任意 | 登録内容 | 数値(0:OFF, 1:ON) |
解錠後開放 | keep_unlock | 必須 | 任意 | 登録内容 | 数値(0:OFF, 1:ON) |
自動解錠 | auto_unlock_flag | 必須 | 任意 | 登録内容 | 数値(0:OFF, 1:ON) |
※無期限解錠が0の場合任意
戻り値
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
鍵ID | key_id | 任意 | 登録した鍵のID | 数値(鍵のID値指定) |
鍵プラン | key_plan_id | 任意 | 登録したプランのID | 数値(鍵プランのID値指定) |
エラーチェック
ステータス | メッセージ |
---|---|
E210000 | 入力値がありません |
E210101 | 接続許可が出ていない場所からの接続です |
E210201 | 鍵IDは数値です |
E210301 | 端末区分は必須項目です |
E210302 | 端末区分は数値です |
E210401 | 携帯電話番号は必須項目です |
E210402 | 携帯電話番号は数値です |
E210501 | MDOのIDは必須項目です |
E210502 | MDOのIDは数値です |
E210601 | 解錠可能期間(開始)は必須項目です |
E210602 | 解錠可能期間(開始)が年月日ではありません |
E210603 | 解錠可能期間が不正です |
E210701 | 解錠可能期間(終了)は必須項目です |
E210702 | 解錠可能期間(終了)が年月日時分秒ではありません |
E210801 | 無期限解錠可は必須項目です |
E210802 | 無期限解錠可は0か1です |
E210901 | 常時解錠は必須項目です |
E210902 | 常時解錠は0か1です |
E210903 | 無期限解錠可と常時解錠は共に1にすることはできません |
E210904 | 1日以上常時解錠することはできません |
E211001 | ユーザーが見つかりません |
E211002 | コントロールパネルが見つかりません |
E211003 | Keyが見つかりません |
E211004 | データベースの保存に失敗しました |
E211005 | データベースの保存に失敗しました |
E211006 | ユーザーが見つかりません |
E211007 | 既に登録済みの鍵プランです。 |
E211008 | データベースの保存に失敗しました |
E212001 | 認証エラーです |
鍵削除
鍵の削除 もしくは 鍵プランの解除を行う。 同時に指定した場合は鍵プランの解除のみ行う。
URL
https://md.moudee.co.jp/group_application_key_deletes/index |
入力項目
論理名 | 物理名 | 鍵登録時 | 鍵プラン登録時 | 備考 | 型 |
---|---|---|---|---|---|
APIキー | api_key | 必須 | 必須 | 認証キー | 文字列 |
鍵ID | key_id | 必須 | 任意 | 検索条件 | 数値(鍵のID値指定) |
鍵プラン | key_plan_id | 任意 | 必須 | 検索条件 | 数値(鍵プランのID値指定) |
電話番号 | user_id | 任意 | 必須 | 検索条件 | 数値 |
戻り値
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
鍵ID | key_id | 任意 | 削除した鍵のID | 数値(鍵のID値指定) |
鍵プラン | key_plan_id | 任意 | 解除したプランのID | 数値(鍵プランのID値指定) |
エラーチェック
ステータス | メッセージ |
---|---|
E240000 | 入力値がありません |
E240101 | 接続許可が出ていない場所からの接続です |
E240201 | 鍵IDは必須項目です |
E240202 | 鍵IDは数値です |
E240203 | 鍵プランIDは数値です |
E240204 | 登録されていない鍵プランです |
E240205 | ユーザーが見つかりません |
E240301 | 鍵が存在しません |
E240302 | 鍵がすでに削除されています |
E240401 | データベースエラー |
E240501 | 認証エラーです |
ログCSV出力
1日分のログをCSV形式で取得する。
入力チェックが1の場合JSON形式で入力値のチェックのみ行われる。
入力チェックが0の場合エラーが発生した場合はヘッダーのみ出力される。
日付未設定の場合は当日のログをダウンロードとなる。
※2回リクエストしてもらいます。最初にAjax等で入力チェック=1でリクエストすると入力値が確認されます。
戻り値 ステータス0で返ってきた場合、CSVが取得可能なので、入力チェックを0に変更してPOSTすると、CSVダウンロードできます。
URL
https://md.moudee.co.jp/group_application_log_lists/index |
入力項目
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
APIキー | api_key | 必須 | 認証キー | 文字列 |
MDO | mdo_id | 任意 | 検索条件 | 数値(MDOのID値指定) |
日付 | date | 任意 | 検索条件 | 日付形式(YYYY-MM-DD or YYYY/MM/DD) |
入力チェック | check_flag | 任意 | 動作切替 | 数値(1:入力値チェック,0:csv出力) |
戻り値 1 input check is 1
論理名 | 物理名 | 必須 | 備考 | 型 |
---|---|---|---|---|
ステータス | status | 必須 | 結果 | 数値(0:正常, それ以外:エラー) |
メッセージ | message | 必須 | エラー文言 | 文字列 |
戻り値2 ※入力チェックが0、未入力の場合
CSVファイルを出力
CSV example
ファイル名:logCsv.csv
“””登録日””,””拠点名””,””スペース名””,””ユーザー名””,””携帯電話番号””,””会社名””,””送信/受信””,””指示/状態”” “”2016-12-21 16:36:51″”,””bqグループ””,””bqグループ拠点””,””bqグループスペース””,””””,””””,””””,””送信””,””解錠(外部Web)”” “”2016-12-21 14:33:46″”,””bqグループ””,””bqグループ拠点””,””bqグループスペース””,””””,””””,””””,””送信””,””解錠(外部Web)”” “”2016-12-21 14:33:38″”,””bqグループ””,””bq拠点22″”,””bqスペース22″”,””””,””””,””””,””送信””,””解錠(外部Web)””” |
エラーチェック
ステータス | メッセージ |
---|---|
E230000 | 入力値がありません |
E230101 | 接続許可が出ていない場所からの接続です |
E230201 | MDOのIDは数値です |
E230202 | MDOのIDの値が不正です |
E230301 | ログ取得期間(開始)が年月日時分秒ではありません |
E230401 | ログ取得期間(終了)が年月日時分秒ではありません |
E230501 | 認証エラーです |
E230601 | 入力チェックは0か1です |
E230701 | CSVダウンロード件数が上限を超えています。検索条件を追加して絞り込みを行ってください。 |