Login REST API#
- POST /mxcube/api/v0.1/login/#
Login into mxcube application.
- Returns:
Response Object, Content-Type: application/json, an object
containing following info:
- {‘status’:{ ‘code’: ‘ok’, ‘msg’: msg },
‘Proposal’: proposal, ‘session’: todays_session, ‘local_contact’: local_contact, ‘person’: someone, ‘laboratory’: a_laboratory]}
Status code set to: 200: On success 409: Error, could not log in
- GET /mxcube/api/v0.1/login/signout#
Signout from MXCuBE Web and reset the session
- GET /mxcube/api/v0.1/login/login_info#
Retrieve session/login info
- Returns:
Response Object, Content-Type: application/json, an object containing:
{‘synchrotron_name’: synchrotron_name, ‘beamline_name’: beamline_name, ‘loginType’: loginType, ‘loggedIn’: True, ‘Proposal’: proposal, ‘session’: todays_session, ‘local_contact’: local_contact, ‘person’: someone, ‘laboratory’: a_laboratory’]}}
Status code set to: 200: On success 200: Error, could not log in, {“loggedIn”: False}