Programming Guide to the Hours of Service Platform

Permissions

The Permissions endpoint is a read-only API that shows all Permissions that can be included in a User Role. The Permissions API is used for creating a User role and is shown on the Users API based on the User Roles that have been assigned to the User.

Fields

Tag Data Type Description
category Character (100) The category where the Permission belongs to. Categories include:

  • Users
  • Terminals
  • User Admin
  • Drivers
  • Driver Logs
  • Violations
  • Unidentified Driving Events
  • Reports
  • DVIR History
  • Fuel Receipts
  • Mobile Worker
  • Alerts
  • Locations
displayName Character (100) The display name of the Permission
id Auto-incremented Long Unique Identifier
name Character (100) The name of the Permission.
system Boolean Indicates if a Permission is system or not.

Permissions

Name Description
PERM_IS_ACCOUNT_ADMIN Indicates if a User has Account Admin Permissions. An Account Admin has overall access to the Account.
PERM_IS_FLEET_MANAGER Indicates if a User has Fleet Manager Permissions. 
PERM_IS_USER_ADMIN Indicates if a User has User Admin Permissions. 
PERM_IS_ASSET_ADMIN Indicates if a User has Asset Admin Permissions. An Asset Admin can manage the Account’s Assets (Users, Drivers, Equipment)
PERM_IS_ELEVATED_USER Indicates if a User has Elevated User Permissions. 
PERM_IS_DRIVER Indicates if a User has Driver Permissions. 
PERM_IS_WORK_ORDER_ASSIGNEE Indicates if a User has Work Order Assignee Permissions. 
PERM_VIEW_ALL_TERMINALS Indicates if a User has Permission to view the all Terminals or only his/her authorized Terminals in the portal.  
PERM_EDIT_USER_PASSWORDS Indicates if a User has Permission to change User passwords in the portal. 
PERM_VIEW_PORTAL_DRIVERS_TAB Indicates if a User has Permission to view the Drivers tab in the portal. 
PERM_VIEW_PORTAL_DRIVER_LOGS_TAB Indicates if a User has Permission to view the Driver Logs tab in the portal.
PERM_EDIT_PORTAL_DRIVER_LOGS_TAB Indicates if a User has Permission to perform the following on the Driver Logs tab in the portal:

  • Request edits
  • Use multiple edit feature
  • Add a status
  • Add an exemption
PERM_VIEW_PORTAL_VIOLATIONS_TAB Indicates if a User has Permission to view the Violations tab in the portal. 
PERM_VIEW_PORTAL_UNIDENTIFIED_DRIVING_EVENTS_TAB Indicates if a User has Permission to view the Unidentified Driving Events tab in the portal. 
PERM_VIEW_PORTAL_HOS_REPORTS_TAB Indicates if a User has Permission to view the HOS Reports tab in the portal.
PERM_VIEW_PORTAL_DVIR_HISTORY_TAB Indicates if a User has Permission to view the DVIR History tab in the portal.
PERM_VIEW_PORTAL_MALFUNCTIONS_AND_DATA_DIAGNOSTICS Indicates if a User has Permission to view the Malfunctions & Data Diagnostics tab in the portal.
PERM_VIEW_PORTAL_LOG_EDITS Indicates if a User has Permission to view the Log Edits tab in the portal.
PERM_EDIT_TERMINALS Indicates if a User has Permission to edit Terminals in the Terminals tab in the portal.
PERM_EDIT_DVIR_FORMS Indicates if a User has Permission to edit DVIR Forms in the DVIR Forms tab in the portal.
PERM_EDIT_DRIVERS Indicates if a User has Permission to edit Drivers. 
PERM_EDIT_EQUIPMENT  Indicates if a User has Permission to edit Equipment. 
PERM_VIEW_ALL_USERS  Indicates if a User has Permission to view other Users’ data.
PERM_EDIT_FUEL_RECEIPTS_TAB  Indicates if a User has Permission to edit Fuel Receipts in the Fuel Receipts tab in the portal. 
PERM_EDIT_PORTAL_VIOLATIONS_TAB  Indicates if a User has Permission to edit Violation Documents in the Violations tab in the portal. 
PERM_EDIT_PORTAL_UNIDENTIFIED_DRIVING_EVENTS_TAB  Indicates if a User has Permission to edit unidentified driving events in the Unidentified Driving Events tab in the portal. 
PERM_EDIT_PORTAL_LOG_EDITS  Indicates if a User has Permission to edit log edits in the Log Edits tab in the portal. 
PERM_VIEW_CERTIFIED_LOGS  Indicates if a User has Permission to view the uploaded Certified Logs of other drivers. 
PERM_VIEW_DVIR_REPORTS  Indicates if a User has Permission to view the uploaded DVIR Reports of other drivers.
PERM_EDIT_DVIRS  Indicates if a User has Permission to edit DVIRS.
PERM_EDIT_JOB_SITES Indicates if a User has Permission to edit Job Sites.
PERM_VIEW_PORTAL_JOB_SITES_TAB Indicates if a User has Permission to view Job Sites in the Jobsites tab in the portal. 
PERM_EDIT_WORK_ORDERS Indicates if a User has Permission to edit Work Orders.
PERM_VIEW_PORTAL_WORK_ORDERS_TAB Indicates if a User has Permission to view Work Orders in the Work Orders tab in the portal.  
PERM_VIEW_PORTAL_FUEL_RECEIPTS_TAB Indicates if a User has Permission to view the IFTA Fuel Receipts tab in the portal.
PERM_VIEW_PORTAL_IFTA_REPORTS_TAB Indicates if a User has Permission to view the IFTA Reports tab in the portal.
PERM_VIEW_PORTAL_WORK_ORDER_REPORTS_TAB Indicates if a User has Permission to view the Work Order Reports tab in the portal.
PERM_EDIT_ALERTS Indicates if a User has Permission to edit Alerts.
PERM_VIEW_PORTAL_LOCATIONS_TAB Indicates if a User has Permission to view the Locations tab in the portal.
PERM_EDIT_CARRIER_INFORMATION Indicates if a User has Permission to edit the Carrier Information

Read

API PATH: /api/v2/Permissions
METHOD: GET
PARAMETERS: name – Retrieves matching records based on the name (e.g. name=PERM_IS_ACCOUNT_ADMIN, all names by default)
offset – Retrieves matching records after an offset value (e.g. offset=2, zero offset by default)
limit – Retrieves a number of records per page specified by the value (e.g. limit=10, all records by default)
SORTING: sort=id – Sort records by their id field in ascending order (DEFAULT)
sort=-id – Sort records by their id field in descending order
sort=name – Sort records by their name field in ascending order
sort=-name – Sort records by their name field in descending order
sort=display-name – Sort records by their displayName field in ascending order
sort=-display-name – Sort records by their displayName field in descending order
sort=category – Sort records by their category field in ascending order
sort=-category – Sort records by their category field in descending order
sort=system – Sort records by their system field in ascending order
sort=-system – Sort records by their system field in descending order
QUERY STRING EXAMPLE Get two Permissions of the current Account with an offset of 1 : ?offset=1&limit=2
Get all Permissions of the current Account sorted by names alphabetically: ?sort=name
EXAMPLE RESPONSE: 
[
  {
    "name": "PERM_IS_ACCOUNT_ADMIN ",
    "displayName": "PERM_IS_ACCOUNT_ADMIN",
    "category": "Users",
    "system": true,
    "id": 4
  }
]