LEADTOOLS Web Services

Several LEADTOOLS SDKs offer imaging and document functionality in the form of ASP.NET Web API Rest services implemented with an MVC architecture that are designed to be easily accessed by any application for a platform-independent solution.

The Web API Services provide a simple JSON interface for HTML5 / JavaScript applications. Developers using high-level environments such as .NET, Java, JavaScript and more, can utilize these LEADTOOLS MVC REST Web Services.

See below for LEADTOOLS MVC Web API and REST Services that are provided with source code:

DemoServices

ASP.NET Web API project located in:

.NET Framework: [Your installation folder]\Examples\Main\JS\DemoServices\fx

.NET Core: [Your installation folder]\Examples\Main\JS\DemoServices\core

Service Features Relevant Source Code
BankCheck

Parsing bank check image files and returning important fields.

DemoServices - BankCheckController.cs
Barcode

Reading barcodes in raster images and obtaining the resulting data.

DemoServices - BarcodeController.cs
Data

Storing / retreiving annotations via XML. The Annotations Demo also uses this controller to rasterize SVG documents due to a security issue in Internet Explorer.

DemoServices - DataController.cs
DriverLicense

Parsing driver license image files and returning important fields.

DemoServices - DriverLicenseController.cs
MRTD

Parsing MRTD image files (such as passports) and returning important fields.

DemoServices - MRTDController.cs
OCR

Performing OCR on raster images and obtaining the resulting text.

DemoServices - OcrController.cs
PDF

Retrieving bookmarks, signatures, and form fields in PDF documents provided by URL.

DemoServices - PdfController.cs
Raster

Parsing image information and loading raster images.

This service also supports loading an image of any format and converting it to one of the following:

  • "image/jpeg" for JPEG
  • "image/png" for PNG
  • "image/gif" for GIF
  • "image/tiff" for TIF
  • "image/x-lead-cmp" for LEAD CMP
  • "image/bmp" for BMP
  • "application/pdf" for PDF
  • "image/x-jpeg-2000" for JPEG 2000
  • "image/x-lead-cmw" for LEAD CMW
  • "image/x-jpeg-xr" for JPEG XR (JXR)
  • "image/x-xps" for Microsoft XPS
DemoServices - RasterController.cs

DocumentService

ASP.NET Web API project (and Java Jersey web API project) located in:

.NET Framework: [Your installation folder]\Examples\Document\JS\DocumentServiceDotNet\fx

.NET Core: [Your installation folder]\Examples\Document\JS\DocumentServiceDotNet\core

Source files: [Your installation folder]\Examples\Document\JS\DocumentServiceDotNet\src

Java: [Your installation folder]\Examples\Document\JS\DocumentServiceJava\document-service

Service Features Relevant Source Code
Annotations

Loading, saving, and updating the annotations within a LEADDocument.

DocumentService - AnnotationsController.cs
Cache

Streaming/retrieving items from a FileCache.

DocumentService - CacheController.cs
Compare

Comparing two documents, as text or as images, and returning the results either visually or as a markdown report.

DocumentService - CompareController.cs
CorsProxy

Behaves as a proxy for web requests to ensure the CORS headers are properly configured. Primarily used to ensure drawing images doesn't taint the canvas (more info https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image).

DocumentService - CorsProxyController.cs
Document

Decrypting and converting documents using the LEADDocument instance.

DocumentService - DocumentController.cs
Factory

Uploading, downloading, saving, and deleting LEADDocument data to/from a FileCache.

DocumentService - FactoryController.cs
Images

Retrieving multiple document pages as a single combined thumbnail image.

DocumentService - ImagesController.cs
Page

Retrieving LEADDocument pages as raster or SVG images and retrieving page text or annotations.

DocumentService - PageController.cs
SharePoint

Listing and retrieving files from a SharePoint directory.

DocumentService - SharePointController.cs
StatusJobConverter

Utilizes the StatusJobDataRunner to convert the documents, allowing for status querying and cancellation of the requests.

DocumentService - StatusJobConverterController.cs
Structure

Parsing and returning bookmarks and page links for a LEADDocument.

DocumentService - StructureController.cs

MedicalWebViewer WCF Services

WCF service located in Examples\Viewers\DotNet\MedicalWebViewer\Medical.WebViewer.WCF

Service Features Relevant Source Code from WebViewerService sub-folder
AuditLogService Creating DICOM audit logs. AuditLogService.cs
AuthenticationService Authenticating users and managing users, rights, permissions and roles AuthenticationService.cs
ExportService Exporting DICOM datasets. ExportService.cs
MonitorCalibrationService Storing and retrieving monitor calibrations. MonitorCalibrationService.cs
ObjectQueryService Performing a DICOM query against a Hosted Web Server. ObjectQueryService.cs
ObjectRetrieveService Retrieving images, image information, and DICOM metadata from a host Web Server. ObjectRetrieveService.cs
OptionsService Getting and setting the Web Viewer options. OptionsService.cs
PacsQueryService Performing a DICOM query against a remote DICOM server. PacsQueryService.cs
PACSRetrieveService Performing DICOM C-MOVE operations and managing a download queue. PACSRetrieveService.cs
PatientAccessRightsService Managing access to patient information based on the user's credentials. PatientAccessRightsService.cs
PatientService Managing patients (adding, removing and updating). PatientService.cs
StoreService Storing DICOM files (files upload). StoreService.cs
TemplateService Managing templates (adding, removing and updating). TemplateService.cs

MedicalWebViewer ASP.Net Services

ASP service located in Examples\Viewers\DotNet\MedicalWebViewer\Medical.WebViewer.Asp\Medical.WebViewer

Service Features Relevant Source Code from Services\Implementation sub-folder
audit Creating DICOM audit logs. AuditHandler.cs
auth Authenticating users and managing users, rights, permissions and roles AuthHandler.cs
export Exporting DICOM datasets. ExportHandler.cs
monitorcalibration Storing and retrieving monitor calibrations. MonitorCalibrationHandler.cs
query Performing a DICOM query against a Hosted Web Server. QueryHandler.cs
retrieve Retrieving images, image information, and DICOM metadata from a host Web Server. RetrieveHandler.cs
options Getting and setting Web Viewer options. OptionsHandler.cs
pacsquery Performing a DICOM query against a remote DICOM server. PacsQueryHandler.cs
pacsretrieve Performing DICOM C-MOVE operations and managing a download queue. PACSRetrieveHandler.cs
patientaccessrights Managing access to patient information based on the user's credentials. PatientAccessRightsHandler.cs
patient Managing patients (adding, removing and updating). PatientHandler.cs
store Storing DICOM files (files upload). StoreHandler.cs
template Managing templates (adding, removing and updating). TemplateHandler.cs

LEADTOOLS Services Host Manager

Utility to configure IIS to host the LEADTOOLS Medical Services, located in Examples\Main\JS\LeadtoolsServicesHostManager.

WADO Service

Service for performing WADO/DicomNet operations using the Medical toolkit, located in Examples\Medical\JS\WADODemo\Medical.WADO. Operations include Query/Retrieval of a DICOM instance and using it with the WADO Client.

See Also

Source Code

Help Version 23.0.2024.5.10
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS HTML5 JavaScript
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.