Driver
Provides a RESTful endpoint for Driver resources and child collections.
| API | Description |
|---|---|
| POST Api/v1/Drivers |
Creates a new driver. |
| PUT Api/v1/Drivers/{id} |
Updates an existing driver. |
| PUT Api/v1/Drivers/BulkUpdate |
Update a collection of drivers. |
| DELETE Api/v1/Drivers/{id} |
Deletes a driver. |
| GET Api/v1/Drivers/{id} |
Fetches a driver by public ID. |
| GET Api/v1/Drivers/{ids} |
Fetches many drivers by ID. This action accepts a comma separated list of ID's in the URL Path segment. |
| GET Api/v1/Drivers/current?terminal={terminal}&sortBy={sortBy}&sortOrder={sortOrder}&nameFilter={nameFilter} |
No documentation available. |
| GET Api/v1/Drivers |
Fetches a paged list of drivers matching the given search criteria. |
| GET Api/v1/Drivers/summary |
No documentation available. |
| GET Api/v1/Drivers/{id}/Assessments?start={start}&end={end} |
No documentation available. |
| GET Api/v1/Drivers/{id}/Logs?start={start}&end={end}&days={days}&trimFutureDates={trimFutureDates} |
Fetches driver logsheets for the given time span. If no time span is provided, this method will return 16 days worth of logsheets for the drivers current assessment period. |
| POST Api/v1/Drivers/EnableDriver/{driverPublicId} |
Enables Joins for a driver |
| POST Api/v1/Drivers/UndeleteDriver/{driverPublicId} |
Enables Joins for a driver |
| POST Api/v1/Drivers/DisableDriver |
Disables Joins for a driver |
| GET Api/v1/Drivers/{id}/Print?start={start}&end={end}&metric={metric}&days={days}&violations={violations}&pdf={pdf} |
No documentation available. |
| GET Api/v1/Drivers/Print?driverIds={driverIds}&start={start}&end={end}&metric={metric}&days={days}&violations={violations}&pdf={pdf} |
Prints driver logsheets for the given driver ID's. By default this will render to PDF, however for debugging purposes you can render raw HTML by setting "pdf=false". |
| POST Api/v1/Drivers/Email |
Sends an e-mail containing the PDF logsheet for the provided driver ID's. |
| GET Api/v1/Drivers/{driverPublicId}/vehicle?eventDate={eventDate} |
Retrieves the vehicle status change event with type of Vehicle Joined that was in effect at the time of the event date. |
MilesWithoutHours
| API | Description |
|---|---|
| GET Api/v1/Miles/{id} |
Fetches a miles no driver record by ID. |
| GET Api/v1/Miles/{ids} |
Fetches many miles no driver records by ID. This action accepts a comma separated list of ID's in the URL Path segment. |
| GET Api/v1/Miles?page={page}&pageSize={pageSize}&sort={sort}&order={order} |
Fetches a paged list of mile without driver records, matching the given search criteria. |
| POST Api/v1/Miles/{id}/Assign |
No documentation available. |
| POST Api/v1/Miles/AssignAll?ids={ids} |
No documentation available. |
Company
Provides a RESTful endpoint for querying the current company and updating company-wide settings.
| API | Description |
|---|---|
| GET Api/v1/Company |
Returns information about the authenticated company. |
| PUT Api/v1/Company |
Updates company address and USDOT information. |
| GET Api/v1/Company/Settings |
Returns the company-wide hours of service configuration. |
| PUT Api/v1/Company/Settings |
Updates the company-wide hours of service configuration. |
| GET Api/v1/Company/Settings/Terminal |
Returns the company-wide terminal defaults (used when creating a new terminal). |
| PUT Api/v1/Company/Settings/Terminal |
Updates the company-wide terminal defaults. |
Terminal
Provides a RESTful endpoint for Terminals.
| API | Description |
|---|---|
| POST Api/v1/Terminals |
Creates a new terminal. |
| PUT Api/v1/Terminals/{id} |
Updates an existing terminal. |
| DELETE Api/v1/Terminals/{id} |
Deletes a terminal. |
| GET Api/v1/Terminals/{id} |
Fetches a terminal by ID |
| GET Api/v1/Terminals?search={search}&page={page}&pageSize={pageSize}&sort={sort}&order={order} |
Returns a paged list of all Terminals. |
| GET Api/v1/Terminals/getallterminals |
No documentation available. |
Messaging
| API | Description |
|---|---|
| POST Api/v1/Messaging/UmfMessage |
Sends a umf message into the backend, this is a secondary path that replicates how the icap sends messages It is intended to be a second path for messages from the icap being sent through satellite channels |
| POST Api/v1/Messaging/UmfMessageAsString |
Sends a umf message into the backend, this is a secondary path that replicates how the icap sends messages It is intended to be a second path for messages from the icap being sent through satellite channels |
| GET Api/v1/Messaging |
No documentation available. |
Vehicle
Provides a RESTful endpoint for Vehicles.
| API | Description |
|---|---|
| POST Api/v1/Vehicles |
Creates a new vehicle. |
| PUT Api/v1/Vehicles/{number} |
Updates an existing vehicle. |
| PUT Api/v1/Vehicles/BulkUpdate |
Update a colleciton of vehicles. |
| DELETE Api/v1/Vehicles/{number} |
Deletes a vehicle. |
| GET Api/v1/Vehicles/{number} |
Fetches a vehicle by number. |
| GET Api/v1/Vehicles/{number}/Drivers |
Return a list of drivers logged into the given vehicle. |
| POST Api/v1/Vehicles/{number}/ForceLeave?driverId={driverId} |
Forces drivers to be signed out of a vehicle. If no driver ID is provided, all currently logged in drivers will be forced to log out. |
| GET Api/v1/Vehicles/{number}/Device |
Fetches the onboard device details for a vehicle. |
| GET Api/v1/Vehicles?page={page}&pageSize={pageSize}&sort={sort}&order={order} |
Returns a paged list of all Vehicles. |
| GET Api/v1/Vehicles/List |
No documentation available. |
VehicleGroups
| API | Description |
|---|---|
| POST Api/v1/VehicleGroups |
No documentation available. |
| PUT Api/v1/VehicleGroups |
No documentation available. |
| GET Api/v1/Company/VehicleGroups |
No documentation available. |
| GET Api/v1/Company/VehiclesByVehicleGroup |
No documentation available. |
Device
| API | Description |
|---|---|
| POST Api/v1/Devices |
Creates a new onboard device. |
| DELETE Api/v1/Devices/{esn} |
Deletes a device from the system. |
| POST Api/v1/Devices/{esn}/Attach/{vehicleNumber} |
Attaches a device to a vehicle, optionally creating a new device for the provided ESN if it does not already exist in the system. |
| POST Api/v1/Devices/{esn}/Detatch?delete={delete} |
Detatches a device from the vehicle. The detached device can optionally be deleted from the system if it is not be re-assigned to a new vehicle. |
| GET Api/v1/Devices/{esn} |
Fetches a device by ESN. |
| GET Api/v1/Devices/{esn}/Endpoint |
Fetches the IP endpoint used by the system for network communication with this device. |
| GET Api/v1/Devices |
Fetch a list of all devices for the company. |
Auth
| API | Description |
|---|---|
| POST Api/v1/Auth |
Driver authentication endpoint, authenticates the given set of crednetials and returns a login token that can be used to authorize future requests. |
| POST Api/v1/Auth/ForgotPassword |
No documentation available. |
| POST Api/v1/Auth/ForgotUsername |
Forms a driver username lookup and sends an e-mail containing the credentials to the users registered e-mail account. |
| POST Api/v1/Auth/ChangePassword |
Changes the user's password using the generated password reset token. |
Status
| API | Description |
|---|---|
| GET Api/v1/Status |
No documentation available. |
Landmark
Provides a RESTful endpoint for GPS landmarks.
| API | Description |
|---|---|
| POST Api/v1/Landmarks |
Creates a new landmark. |
| PUT Api/v1/Landmarks/{id} |
Updates an existing landmark. |
| DELETE Api/v1/Landmarks/{id} |
Deletes a landmark. |
| GET Api/v1/Landmarks/{id} |
Fetches a landmark by public ID. |
| GET Api/v1/Landmarks |
Fetches a list of all landmarks for the company. |
Organization
Provides a RESTful endpoint for Organizations.
| API | Description |
|---|---|
| POST Api/v1/Organizations |
Creates a new organization. |
| PUT Api/v1/Organizations/{id} |
Updates an existing organization. |
| DELETE Api/v1/Organizations/{id} |
Deletes an organization. |
| GET Api/v1/Organizations/{id} |
Fetches a organization by ID |
| GET Api/v1/Organizations/{id}/Drivers |
Returns a list of drivers associated with this organization. |
| GET Api/v1/Organizations?search={search}&page={page}&pageSize={pageSize}&sort={sort}&order={order} |
Returns a paged list of all organizations. |
DutyStatus
Update a drivers logbook by changing their duty status or performing correction. Duty status changes cause the driver to be evaluated by the regulation engine for possible violations.
| API | Description |
|---|---|
| POST Api/v1/DutyStatus/Add |
Change a driver's duty status. Only the driver themselves should be changing their duty status - all other change must be done as corrections. |
| POST Api/v1/DutyStatus/Correction |
Perform a historical correction of a drivers past duty status. |
ELDMigration
Provides supporting methods for the ELD Migration Process.
| API | Description |
|---|---|
| POST Api/v1/ELDMigration/sendupdate |
Sends the ELD Migration Status Update to the client via the Migration SignalR Hub |
AutoAssignment
Provides a RESTful endpoint for configuring miles without hours auto assignment rules.
| API | Description |
|---|---|
| GET Api/v1/AutoAssignment/Landmark |
No documentation available. |
| GET Api/v1/AutoAssignment/Landmark/{id} |
No documentation available. |
| POST Api/v1/AutoAssignment/Landmark |
No documentation available. |
| PUT Api/v1/AutoAssignment/Landmark/{id} |
No documentation available. |
| DELETE Api/v1/AutoAssignment/Landmark/{id} |
No documentation available. |
| GET Api/v1/AutoAssignment/ShortHop |
No documentation available. |
| GET Api/v1/AutoAssignment/ShortHop/All |
No documentation available. |
| POST Api/v1/AutoAssignment/ShortHop |
No documentation available. |
Reports
RESTful endpoint for Hours of Service summary reports.
| API | Description |
|---|---|
| GET Api/v1/Reports/MilesWithoutHoursSummary |
Summary of Miles Without Hours data for a given search criteria. |
| GET Api/v1/Reports/LogsheetSummary?start={start}&end={end}&driverId={driverId} |
No documentation available. |
| GET Api/v1/Reports/LogsheetSummaryAsCsv?start={start}&end={end}&driverId={driverId} |
No documentation available. |
| GET Api/v1/Reports/ViolationSummary?start={start}&end={end}&terminalId={terminalId}&driverId={driverId} |
No documentation available. |
Regulation
Provides a RESTful endpoint for Regulation Codes.
| API | Description |
|---|---|
| GET Api/v1/Regulations |
Returns a list of all Regulation Codes. |
| POST Api/v1/Regulations/ApplyAssessment |
No documentation available. |
Provides a RESTful endpoint for background print jobs.
| API | Description |
|---|---|
| POST Api/v1/Print |
Prints logsheets for a groupof drivers. Printing is handled in the background and the state of the print job can be checked by querying the job, or subscribing to the SignalR endpoint. |
| GET Api/v1/Print/{jobId} |
No documentation available. |
| GET Api/v1/Print/{jobId}/File |
No documentation available. |
| GET Api/v1/Print/{jobId}/{taskId} |
No documentation available. |
| GET Api/v1/Print/{jobId}/{taskId}/File |
No documentation available. |