go back Home

StopService

This service provides methods for getting stops, stop notes and reference numbers for orders.

Operations

name role description
DELETE /stops/{stopId}/referenceNumbers/{id} Users Deletes a reference number from a stop
DELETE /stops/{stopId}/stopNotes/{id} Users Deletes a stop note from a stop
GET /stops/{id} Users, Drivers Retrieves a stop and the associated reference numbers and stop notes.
GET /stops/{id}/referenceNumbers Users, Drivers, Carriers, Carrier Drivers Retrieves reference numbers for the specified stop ID
GET /stops/{id}/referenceNumbers/new Users Creates a reference number object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /stops/{id}/stopNotes Users, Drivers, Carriers, Carrier Drivers Retrieves stop notes for the specified stop ID