go back Home

ImagingService

This service provides operations that fetch images and data out of and allows for new images to be placed in Imaging.

Operations

name role description
GET /images/{id} Users, Drivers, Carriers, Carrier Drivers Retrieves the image for the given ID from Imaging. If no mimetype is supplied, we'll default it as "application/pdf" for PDF since it can handle multi-page TIFFs that imaging often contains. If you send a different type like "image/png" and the image from imaging is a multi-page TIFF, you will most likely get the first page of the TIFF, although that's not guaranteed.
GET /images/{rowType}/{rowId} Users, Drivers, Carriers, Carrier Drivers Retrieves a list of images available for the given type and ID.
GET /images/{rowType}/{rowId}/documentTypes Users, Drivers, Carriers, Carrier Drivers Gets the list of document types available for the row.
POST /images/{rowType}/{rowId}/{documentTypeId} Users, Drivers, Carriers, Carrier Drivers Stores the uploaded image into imaging. Some providers may simply stage the uploaded image and later pick it up with a batch process whereas others may immediately store it, making it ready for immediate retrieval.