Description
Documentation for the Lab DB RESTful API.
While this API is specific to the LIMS designed for the Linington Lab, minor changes could be made to suit any NP Chemistry research groups needs.
This API drives a MySQL database, for which the schema can be found here.
Overview
API Root
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/ | List API resources |
| GET | /api/v1/heartbeat | API Heartbeat |
Authentication
TODO
Divers
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/divers | List all divers |
| POST | /api/v1/divers | Create a new diver |
| GET | /api/v1/divers/:id | Get one diver |
| DELETE | /api/v1/divers/:id | Delete one diver |
| PUT | /api/v1/divers/:id | Update one diver |
Dive Sites
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/divesites | List all dive sites |
| POST | /api/v1/divesites | Create a new dive site |
| GET | /api/v1/divesites/:id | Get one divesite |
| DELETE | /api/v1/divesites/:id | Delete one divesite |
| PUT | /api/v1/divesites/:id | Update one divesite |
Extracts
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/extracts | List all extracts |
| POST | /api/v1/extracts | Create a new extract |
| GET | /api/v1/extracts/:id | Get one extract |
| DELETE | /api/v1/extracts/:id | Delete one extract |
| PUT | /api/v1/extracts/:id | Update one extract |
Fractions
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/fractions | List all fractions |
| POST | /api/v1/fractions | Create a new fraction |
| GET | /api/v1/fractions/:id | Get one fraction |
| DELETE | /api/v1/fractions/:id | Delete one fraction |
| PUT | /api/v1/fractions/:id | Update one fraction |
Isolates
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/isolates | List all isolates |
| POST | /api/v1/isolates | Create a new isolate |
| GET | /api/v1/isolates/:id | Get one isolate |
| DELETE | /api/v1/isolates/:id | Delete one isolate |
| PUT | /api/v1/isolates/:id | Update one isolate |
Media
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/media | List all media |
| POST | /api/v1/media | Create a new media |
| GET | /api/v1/media/:id | Get one medium |
| DELETE | /api/v1/media/:id | Delete one medium |
| PUT | /api/v1/media/:id | Delete one medium |
Permits
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/permits | List all permits |
| POST | /api/v1/permits | Create a new permit |
| GET | /api/v1/permits/:id | Get one permit |
| DELETE | /api/v1/permits/:id | Delete one permit |
| PUT | /api/v1/permits/:id | Update one permit |
Samples
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/samples | List all samples |
| POST | /api/v1/samples | Create a new sample |
| GET | /api/v1/samples/:id | Get one sample |
| DELETE | /api/v1/samples/:id | Delete one sample |
| PUT | /api/v1/samples/:id | Update one sample |
Sample Types
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/sampletypes | List all sampletypes |
| POST | /api/v1/sampletypes | Create a new sampletype |
| GET | /api/v1/sampletypes/:id | Get one sampletype |
| DELETE | /api/v1/sampletypes/:id | Delete one sampletype |
| PUT | /api/v1/sampletypes/:id | Update one sampletype |
Screen Plates
| HTTP Method | Endpoint | Function |
|---|---|---|
| GET | /api/v1/screenplates | List all screenplates |
| POST | /api/v1/screenplates | Create a new screenplate |
| GET | /api/v1/screenplates/:id | Get one screenplate |
| DELETE | /api/v1/screenplates/:id | Delete one screenplate |
| PUT | /api/v1/screenplates/:id | Update one screenplate |
Versioning
This is the first version of the API.
Changes
No changes