Diffractometer REST API#
- GET /mxcube/api/v0.1/diffractometer/phase#
- Retrieve the current phase in the diffractometer.
- response Content-type:
application/json, example: {‘current_phase’: ‘Centring’}, available phases: [Centring, BeamLocation, DataCollection,
Transfer]
- statuscode:
200: no error
- statuscode:
409: error
- GET /mxcube/api/v0.1/diffractometer/phaselist#
- Retrieve the available phases in the diffractometer.
- response Content-type:
application/json, example: {‘phase_list’: [Centring, BeamLocation, DataCollection,
Transfer]}
- statuscode:
200: no error
- statuscode:
409: error
- PUT /mxcube/api/v0.1/diffractometer/phase#
- Set the phase in the diffractometer.
- request Content-type:
application/json, an object containing the new phase as string, e.g. {‘phase’: ‘Centring’}. [Centring, BeamLocation, DataCollection, Transfer]
- statuscode:
200: no error
- statuscode:
409: error
- GET /mxcube/api/v0.1/diffractometer/platemode#
md_in_plate_mode: check if diffractometer is in plate mode or not data = {“md_in_plate_mode”: } True /False return_data: data plus error code 200/409
- PUT /mxcube/api/v0.1/diffractometer/aperture#
- Move the aperture motor.
- request Content-type:
application/json, new position {‘diameter’: 50}. Note: level specified as integer (not ‘Diameter 50’)
- statuscode:
200: no error
- statuscode:
409: error