Skip to content
pani2004 edited this page Nov 7, 2024 · 1 revision

API Documentation

This document provides an overview of the API endpoints available in this application.


DICOM Routes

Endpoint Method Description Middleware Controller Parameters
/upload-dicom POST Uploads a DICOM file for a specific patient. uploadDicomFile handleDicomFileUpload file: DICOM file (handled by multer)
/patients GET Retrieves all patients with DICOM metadata. None getAllPatientsWithDicomMetadata None
/patients/:patientId/dicom/download GET Downloads all DICOM files for a specific patient. None downloadAllDicomFiles patientId: Unique patient identifier

Template Routes

Endpoint Method Description Controller Parameters
/getTemplates GET Retrieves a list of all templates. getTemplates None
/createTemplate POST Creates a new template. createTemplate Template data in request body

Audio Routes

Endpoint Method Description Middleware Controller Parameters
/:patientID/audio GET Retrieves audio notes for a specific patient. None getAudioNotes patientID: Unique patient identifier
/:patientID/audio POST Uploads an audio note for a specific patient. upload.single('audioFile') saveAudioNote patientID: Unique patient identifier; audioFile: Audio file
/audio/:noteId/stream GET Streams a specific audio note by note ID. None streamAudio noteId: Unique audio note identifier

Each endpoint in the above tables outlines the HTTP method, endpoint URL, description, required middleware, controller function, and any parameters or data expected in the request.

Clone this wiki locally