go back Home

CommentService

This service contains endpoints for retrieval and manipulation of comments and comment attachments.

Operations

name role description
DELETE /comments/{id} Users Deletes a comments record with the given ID.
GET /comments/commentTypes Produces a list of active comment types as defined in LoadMaster.
GET /comments/{id} Users, Drivers, Carriers, Carrier Drivers Retrieves a comment by its ID.
GET /comments/{id}/attachment Users, Drivers, Carriers, Carrier Drivers Retrieves an attachment stored with a comment, if it exists.
GET /comments/{id}/thumbnail Users, Drivers, Carriers, Carrier Drivers Retrieves a PNG thumbnail of the attachment stored with a comment, if it exists. Image attachments yield smaller versions, PDF attachments yield a small version of the first page, other known file types such as Microsoft Word and Excel yield simple generic images of the file types and everything else yields a generic image with a question mark.
GET /comments/{parentRowType}/{parentRowId} Users, Drivers, Carriers, Carrier Drivers Retrieves a list of comments for a given parent row type and row ID. For example, driver BJM01 would be requested as "/D/BJM01", where 'D' represents the parent row type of a driver and 'BJM01' the ID for the driver record.
PUT /comments/create Users, Drivers, Carriers, Carrier Drivers Creates a comments record for the given comment data.
PUT /comments/update Users, Drivers, Carriers, Carrier Drivers Updates a comments record for the given comment data.
PUT /comments/{id}/attachFile Users, Drivers, Carriers, Carrier Drivers