Skip to content

py-ISPyB

About

py-ISPyB

Home
Get Started
Tests
Configuration
Authentication and Authorization
Authentication and Authorization
Routes
Routes
- About About
  Table of contents
  - Routes documentation
  - Java ISPyB compatibility
- ⧉ Endpoint documentation
Simulator
User Portal Sync
Developers
Developers
- Notes
- ⧉ Test coverage

py-ISPyB routes#

Routes documentation#

To get a documentation gathering all the available routes, simply open the /docs route.

You may also check the automatic generated API documentation (Redoc) at: https://ispyb.github.io/py-ispyb/api/

Java ISPyB compatibility#

Legacy routes for compatibility with Java ISPyB are available with the prefix /ispyb/api/v1/legacy.
To preserve compatibility with Java ISPyB, proposal_id parameters in routes also accept proposal names like MX2007.