API (system developer)

User list

The list of user can be obtained in JSON format.

URL

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

Input feed

Item name System name Required Note Type
API key api_key yes Authentication key characters
phone number user_id optional search condition numeric

API result

Item name System name Required Note Type
status status yes result numeric (0: valid other: error)
message message yes error log characters
user information users yes obtained data layout *detailes described below

* user infromation that hit by the search repeats.

User information

Item name System name Required Note Type
registration date created yes obtained data date (YYYY-MM-DD HH:ii:ss)
company name company_name yes obtained data characters
user name user_name yes obtained data characters
phone number user_id yes obtained data numeric
device to unlock terminal_flag yes obtained data characters
patterned password key_pattern yes obtained data numeric
password key_password yes obtained data numeric
mail mail yes obtained data characters
user attribute user_attribute_id yes obtained data numeric
user attribute name user_attribute_name yes obtained data characters
fee start date display_user_attribute yes obtained data date (YYYY-MM-DD HH:ii:ss)

Error check

Status Message
E240000 no input value
E240101 unauthenticated access attempt
E240201 key id is required
E240202 key id is numeric
E240203 key plan is numeric
E240204 unregistered key lan
E240205 user not found
E240301 nonexist key
E240302 deleted key
E240401 database error
E240501 authentication error

User registration

Register user

URL

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

Input feed

Item name System name Required Note Type
API key api_key yes authentication ke characters
phone number user_id yes registered content numeric
company name company_name optional registered content characters
user name user_name optional registered content characters
device to unlock terminal_flag yes registered content numeric (0:tablet  1:smart phone )
user attribute user_attribute_id optional registered content numeric (user attribute ID)
fee start date account_start_date optional registered content date (YYYY-MM-DD or YYYY/MM/DD)

Return value

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error log characters
phone number user_id yes registered phone number numeric
registration update regist_flag yes registered result numeric (0:update, 1:register)
patterned password key_pattern optional login patterned password numeric display only its right it given
password key_password optional login password numeric display only its right it given

Error check

Status Message
E260000 no input value
E260101 unauthenticated access attempt
E260201 phone number is required
E260202 phhon numer is numeric
E260203 phone number digit must be within 20 digit
E260301 name is required
E260302 name character must be under 20 letters
E260303 copmany name character must be under 20 letters
E260401 unlock device is must
E260402 unlock device must be put only in 0 or 1
E260403 user attribute is must
E260404 user attribute number
E260405 fee start date is not inputted in date format
E260501 fail to save user information
E260502 fail to save user information
E260503 fail to save user information
E260504 its phone number exists already in databaase
E260505 its name exsits already in database
E260506 authentication error

Remove user

URL

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

Input feed

Item name System name Required Note Type
api key api_key yes authentication key characters
phone number user_id yes search condition numeric

Return value

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error log characters

Error check

Status Message
E300000 no input value
E300101 unauthenticated access attempt
E300201 phone number is required
E300202 phhon numer is numeric
E300301 nonexist user
E300302 fail to delete user
E300303 fail to register key plan
E300304 fail to delete user
E300401 authentication error

Unlock

URL

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

Input feed

Item name System name Required Note Type
api key api_key yes authentication key characters
Conrol panel (MDO) mdo_id yes MDO id numeric (MDO ID)

Return value

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error log characters

Error check

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

Key registration

Key registration or key plan reigstration: if both items are pointed, then only key plan will be registered
In case of key registration, unlimited key will be prioritized than start/end timeframe set key

URL

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

Input feed

Item name System name Required Key plan reigstration Note Type
api key api_key yes required authentication key characters
phone number user_id yes required registration content numeric
key plan key_plan_id optional required registration content numeric (key plan ID)
key plan start date plan_start_date optional optional registration content date (YYYY-MM-DD or YYYY/MM/DD)
mdo id mdo_id optional optional registration content numeric (MDO ID)
start time start_time yes* optional registration content date (『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』)
end time end_time yes* optional registration content date (『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』)
unlimited unlimited_flag yes optional registration content numeric (0:OFF, 1:ON)
keep lock status unlock keep_unlock yes optional registration content numeric (0:OFF, 1:ON)
auto unlock auto_unlock_flag yes optional registration content numeric (0:OFF, 1:ON)

*use 0 for unlimited

Return value

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error message characters
key id key_id optional registered key ID numeric (key id)
key plan key_plan_id optional registered key plan id numeric (key plan id)

Error check

Status Message
E210000 no input value
E210101 unauthenticated access attempt
E210201 key is numeric
E210301 device selection is required (tablet or smartphone)
E210302 device selection is numeric
E210401 phone numer is required
E210402 phone number is numeric
E210501 MDO ID required
E210502 MDO ID is numeric
E210601 unlock available timeframe is required (start)
E210602 unlock available timeframe formate is not  in date
E210603 unlork avoilab e timeflame is invalid
E210701 unlock available timeframe is required (end)
E210702 unlock available timeframe formate is not  in date
E210801 unlimited key is required
E210802 unlimited key is numeric 0 or 1
E210901 keep lock status unlock is required
E210902 keep lock status unlock is numeric 0 or 1
E210903 unlimited key and keep lock status unlock both can not be set 1
E210904 can not keep lock status unlock over one day
E211001 can not find a user
E211002 can not find a control panel (mdo)
E211003 can not find the key
E211004 fail to save
E211005 fail to save
E211006 can not find a user
E211007 key plan is already registered
E211008 faile to save
E212001 authentication error

Remove key

To delete key or key plan. If it is pointed both, then only delete key plan.

URL

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

Input feed

Item name System name Required Key plan reigstration Note Type
apie key api_key yes required authentication key characters
key id key_id yes required search condition numeric (key ID)
key plan key_plan_id optional required search condition numeric (key plan ID)
phone number user_id optional required search condition numeric (key ID)

Return value

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error message characters
key id key_id optional deleted key ID numeric (key id)
key plan key_plan_id optional deleted key plan ID numeric (key plan id)

Error check

Status Message
E240000 no input value
E240101 unauthenticated access attempt
E240201 key id is required
E240202 key id is numeric
E240203 key plan id is numeric
E240204 unregistered key plan
E240205 can not find the user
E240301 nonexistence key
E240302 key is already deleted
E240401 database error
E240501 authentication error

Log CSV input/output

To obtain one day usage log in csv format.
When input check is 1, only input value check be done in JSON format.
When input check is 0 / error occures, only header will be outputted.
When date is not set, attempt date’s log will be downloaded.
Reqire to attempt twice. First use Ajax or the other to send request in input check =1 to confirm.
When return value is 0, you are able to obtain log by CSV, change input to 0 and post then you are able to download.

URL

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

Input feed

Item name System name Required Note Type
api key api_key yes authentication key characters
mdo id mdo_id optional search condition numeric (MDO ID)
date date optional search condition date (YYYY-MM-DD or YYYY/MM/DD)
input check check_flag optional mode change numeric (1:input check   0:csvouput7)

Return value 1 input check is 1

Item name System name Required Note Type
status status yes result numeric (0: valid, other:error)
message message yes error message characters

Return value 2 *input check 0 or null

Output csv file.

CSV example

File name:logCsv.csv

“register date”,”center name,”space nama”,”user name”,”phonenumber”,”companyname,”send/receive”,”command/lockstatus”
“2016-12-21 16:36:51″,”bq”,”bqgrouppcentera”,bqsharedspace”,””,””,””,”send”,”unlock(outsideweb)”
“2016-12-21 14:33:46″,”bq”,”bqgrouppcenter2″,”bqmeetingroom”,””,””,””,”send”,”unlock(outsideWeb)”
“2016-12-21 14:33:38″,”bq”,”bqcener22″,”bqspace22,””,””,””,”send”,”unlock(outsideWeb)”

Error check

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