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必須取得データ数値
メールmail必須取得データ文字列
ユーザー属性IDuser_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必須認証キー文字列
MDOmdo_id必須対象のMDO数値(MDOのID値指定)

戻り値

論理名物理名必須備考型
ステータスstatus必須結果数値(0:正常, それ以外:エラー)
メッセージmessage必須エラー文言文字列

エラーチェック

StatusMessage
E220000no input value
E220101unauthenticated access attempt
E220201MDO ID required
E220202MDO ID is numeric
E220301MDO ID is invaid
E220401DoorRequest Table DB save failure
E220402log 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)
MDOmdo_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必須エラー文言文字列
鍵IDkey_id任意登録した鍵のID数値(鍵のID値指定)
鍵プランkey_plan_id任意登録したプランのID数値(鍵プランのID値指定)

エラーチェック

ステータスメッセージ
E210000入力値がありません
E210101接続許可が出ていない場所からの接続です
E210201鍵IDは数値です
E210301端末区分は必須項目です
E210302端末区分は数値です
E210401携帯電話番号は必須項目です
E210402携帯電話番号は数値です
E210501MDOのIDは必須項目です
E210502MDOのIDは数値です
E210601解錠可能期間(開始)は必須項目です
E210602解錠可能期間(開始)が年月日ではありません
E210603解錠可能期間が不正です
E210701解錠可能期間(終了)は必須項目です
E210702解錠可能期間(終了)が年月日時分秒ではありません
E210801無期限解錠可は必須項目です
E210802無期限解錠可は0か1です
E210901常時解錠は必須項目です
E210902常時解錠は0か1です
E210903無期限解錠可と常時解錠は共に1にすることはできません
E2109041日以上常時解錠することはできません
E211001ユーザーが見つかりません
E211002コントロールパネルが見つかりません
E211003Keyが見つかりません
E211004データベースの保存に失敗しました
E211005データベースの保存に失敗しました
E211006ユーザーが見つかりません
E211007既に登録済みの鍵プランです。
E211008データベースの保存に失敗しました
E212001認証エラーです

鍵削除

鍵の削除　もしくは　鍵プランの解除を行う。　同時に指定した場合は鍵プランの解除のみ行う。

URL

https://md.moudee.co.jp/group_application_key_deletes/index

入力項目

論理名物理名鍵登録時鍵プラン登録時備考型
APIキーapi_key必須必須認証キー文字列
鍵IDkey_id必須任意検索条件数値(鍵のID値指定)
鍵プランkey_plan_id任意必須検索条件数値(鍵プランのID値指定)
電話番号user_id任意必須検索条件数値

戻り値

論理名物理名必須備考型
ステータスstatus必須結果数値(0:正常, それ以外:エラー)
メッセージmessage必須エラー文言文字列
鍵IDkey_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等で入力チェック=１でリクエストすると入力値が確認されます。
戻り値 　ステータス0で返ってきた場合、CSVが取得可能なので、入力チェックを0に変更してPOSTすると、CSVダウンロードできます。

URL

https://md.moudee.co.jp/group_application_log_lists/index

入力項目

論理名物理名必須備考型
APIキーapi_key必須認証キー文字列
MDOmdo_id任意検索条件数値(MDOのID値指定)
日付date任意検索条件日付形式(YYYY-MM-DD or YYYY/MM/DD)
入力チェックcheck_flag任意動作切替数値(1:入力値チェック,0:csv出力)

戻り値 1 input check is 1

論理名物理名必須備考型
ステータスstatus必須結果数値(0:正常, それ以外:エラー)
メッセージmessage必須エラー文言文字列

戻り値２　※入力チェックが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接続許可が出ていない場所からの接続です
E230201MDOのIDは数値です
E230202MDOのIDの値が不正です
E230301ログ取得期間(開始)が年月日時分秒ではありません
E230401ログ取得期間(終了)が年月日時分秒ではありません
E230501認証エラーです
E230601入力チェックは0か1です
E230701CSVダウンロード件数が上限を超えています。検索条件を追加して絞り込みを行ってください。