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 nameSystem nameRequiredNoteType
API keyapi_keyyesAuthentication keycharacters
phone numberuser_idoptionalsearch conditionnumeric

API result

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid other: error)
messagemessageyeserror logcharacters
user informationusersyesobtained datalayout *detailes described below

* user infromation that hit by the search repeats.

User information

Item nameSystem nameRequiredNoteType
registration datecreatedyesobtained datadate (YYYY-MM-DD HH:ii:ss)
company namecompany_nameyesobtained datacharacters
user nameuser_nameyesobtained datacharacters
phone numberuser_idyesobtained datanumeric
device to unlockterminal_flagyesobtained datacharacters
patterned passwordkey_patternyesobtained datanumeric
passwordkey_passwordyesobtained datanumeric
mailmailyesobtained datacharacters
user attributeuser_attribute_idyesobtained datanumeric
user attribute nameuser_attribute_nameyesobtained datacharacters
fee start datedisplay_user_attributeyesobtained datadate (YYYY-MM-DD HH:ii:ss)

Error check

StatusMessage
E240000no input value
E240101unauthenticated access attempt
E240201key id is required
E240202key id is numeric
E240203key plan is numeric
E240204unregistered key lan
E240205user not found
E240301nonexist key
E240302deleted key
E240401database error
E240501authentication error

User registration

Register user

URL

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

Input feed

Item nameSystem nameRequiredNoteType
API keyapi_keyyesauthentication kecharacters
phone numberuser_idyesregistered contentnumeric
company namecompany_nameoptionalregistered contentcharacters
user nameuser_nameoptionalregistered contentcharacters
device to unlockterminal_flagyesregistered contentnumeric (0:tablet  1:smart phone )
user attributeuser_attribute_idoptionalregistered contentnumeric (user attribute ID)
fee start dateaccount_start_dateoptionalregistered contentdate (YYYY-MM-DD or YYYY/MM/DD)

Return value

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror logcharacters
phone numberuser_idyesregistered phone numbernumeric
registration updateregist_flagyesregistered resultnumeric (0:update, 1:register)
patterned passwordkey_patternoptionallogin patterned passwordnumeric display only its right it given
passwordkey_passwordoptionallogin passwordnumeric display only its right it given

Error check

StatusMessage
E260000no input value
E260101unauthenticated access attempt
E260201phone number is required
E260202phhon numer is numeric
E260203phone number digit must be within 20 digit
E260301name is required
E260302name character must be under 20 letters
E260303copmany name character must be under 20 letters
E260401unlock device is must
E260402unlock device must be put only in 0 or 1
E260403user attribute is must
E260404user attribute number
E260405fee start date is not inputted in date format
E260501fail to save user information
E260502fail to save user information
E260503fail to save user information
E260504its phone number exists already in databaase
E260505its name exsits already in database
E260506authentication error

Remove user

URL

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

Input feed

Item nameSystem nameRequiredNoteType
api keyapi_keyyesauthentication keycharacters
phone numberuser_idyessearch conditionnumeric

Return value

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror logcharacters

Error check

StatusMessage
E300000no input value
E300101unauthenticated access attempt
E300201phone number is required
E300202phhon numer is numeric
E300301nonexist user
E300302fail to delete user
E300303fail to register key plan
E300304fail to delete user
E300401authentication error

Unlock

URL

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

Input feed

Item nameSystem nameRequiredNoteType
api keyapi_keyyesauthentication keycharacters
Conrol panel (MDO)mdo_idyesMDO idnumeric (MDO ID)

Return value

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror logcharacters

Error check

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

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 nameSystem nameRequiredKey plan reigstrationNoteType
api keyapi_keyyesrequiredauthentication keycharacters
phone numberuser_idyesrequiredregistration contentnumeric
key plankey_plan_idoptionalrequiredregistration contentnumeric (key plan ID)
key plan start dateplan_start_dateoptionaloptionalregistration contentdate (YYYY-MM-DD or YYYY/MM/DD)
mdo idmdo_idoptionaloptionalregistration contentnumeric (MDO ID)
start timestart_timeyes*optionalregistration contentdate (『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』)
end timeend_timeyes*optionalregistration contentdate (『YYYY-MM-DD HH:ii』 or 『YYYY/MM/DD HH:ii』)
unlimitedunlimited_flagyesoptionalregistration contentnumeric (0:OFF, 1:ON)
keep lock status unlockkeep_unlockyesoptionalregistration contentnumeric (0:OFF, 1:ON)
auto unlockauto_unlock_flagyesoptionalregistration contentnumeric (0:OFF, 1:ON)

*use 0 for unlimited

Return value

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror messagecharacters
key idkey_idoptionalregistered key IDnumeric (key id)
key plankey_plan_idoptionalregistered key plan idnumeric (key plan id)

Error check

StatusMessage
E210000no input value
E210101unauthenticated access attempt
E210201key is numeric
E210301device selection is required (tablet or smartphone)
E210302device selection is numeric
E210401phone numer is required
E210402phone number is numeric
E210501MDO ID required
E210502MDO ID is numeric
E210601unlock available timeframe is required (start)
E210602unlock available timeframe formate is not  in date
E210603unlork avoilab e timeflame is invalid
E210701unlock available timeframe is required (end)
E210702unlock available timeframe formate is not  in date
E210801unlimited key is required
E210802unlimited key is numeric 0 or 1
E210901keep lock status unlock is required
E210902keep lock status unlock is numeric 0 or 1
E210903unlimited key and keep lock status unlock both can not be set 1
E210904can not keep lock status unlock over one day
E211001can not find a user
E211002can not find a control panel (mdo)
E211003can not find the key
E211004fail to save
E211005fail to save
E211006can not find a user
E211007key plan is already registered
E211008faile to save
E212001authentication 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 nameSystem nameRequiredKey plan reigstrationNoteType
apie keyapi_keyyesrequiredauthentication keycharacters
key idkey_idyesrequiredsearch conditionnumeric (key ID)
key plankey_plan_idoptionalrequiredsearch conditionnumeric (key plan ID)
phone numberuser_idoptionalrequiredsearch conditionnumeric (key ID)

Return value

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror messagecharacters
key idkey_idoptionaldeleted key IDnumeric (key id)
key plankey_plan_idoptionaldeleted key plan IDnumeric (key plan id)

Error check

StatusMessage
E240000no input value
E240101unauthenticated access attempt
E240201key id is required
E240202key id is numeric
E240203key plan id is numeric
E240204unregistered key plan
E240205can not find the user
E240301nonexistence key
E240302key is already deleted
E240401database error
E240501authentication 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 nameSystem nameRequiredNoteType
api keyapi_keyyesauthentication keycharacters
mdo idmdo_idoptionalsearch conditionnumeric (MDO ID)
datedateoptionalsearch conditiondate (YYYY-MM-DD or YYYY/MM/DD)
input checkcheck_flagoptionalmode changenumeric (1:input check   0:csvouput7)

Return value 1 input check is 1

Item nameSystem nameRequiredNoteType
statusstatusyesresultnumeric (0: valid, other:error)
messagemessageyeserror messagecharacters

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

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