Permissions & Scopes
OAuth application permissions are defined when the application is created. In the case of DeliveryGo API, permissions are defined as the set of scopes that are assigned to the OAuth application. Scopes represent resources and the operations that can be performed on those resources.
When an application is created, the application owner can select the scopes that the application will have access to. The application owner can also change the scopes at any time.
During the authentication process, i.e. exchanging client_id and client_secret for an access token, the client must specify which resources it wants to access from the set of available scopes. Permissions correspond to scopes as follows:
Tickets
E-tickets data including batch weights, water details and inspections results.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | ticket:read |
| Read & Export | GET | ticket:readticket:export/download:readticket:export/email:read |
GPS
Devices
Devices registered in DeliveryGo. Includes information on the last known location, the version of the installed application, and the assigned truck.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | device:read |
Snail Trail
Trucks location update logs for the last 30 days, including statuses and metrics.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | snailtrail:read |
Snail Trail Archive (beta)
Trucks location update archive containing logs older than 30 days.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | snailtrailarchive:read |
Timekeeping
Clock-in/Clock-out
Performing clock-in and clock-out actions of a specified employee. The action creates a new Time Log Entry during clock-in or updates an existing one during clock-out.
| Permission | Method | Scopes |
|---|---|---|
| Access | POST | employee:clockIn:writeemployee:clockOut:writeemployee:breakStart:writeemployee:breakEnd:write |
Driver call-outs
Driver call-out schedules including allowed clock-in date and time, phone number, message note and confirmation status.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | employeecallouts:read |
| Read & Write | PUT / PATCH | employeecallouts:reademployeecallouts:writeemployeecallouts:sendNotification:write |
| Admin | DELETE | employeecallouts:reademployeecallouts:writeemployeecallouts:sendNotification:writeemployeecallouts:admin |
Time Categories
Defined in the timekeeping settings, they represent a category of a time log entry.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | timecategory:read |
Time Log Entries
Employees clock-in and clock-out information, including clock-in/out time, location, truck, category and durations.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | timelogentry:read |
Time Offs
Employees time off entries.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | timeoff:read |
Time Reports
Employees timekeeping reports.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | report:employeeduration:read |
Resources
Customers
Customer data, access control & permissions management.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | customer:read |
| Read & Write | PUT / PATCH | customer:readcustomer:write |
Employees
Employees information, including currently assigned truck and default time category
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | employee:read |
Sign-in/Sign-out
Performing the sign-in and sign-out actions of a specified employee. The action assigns the employee to a truck.
| Permission | Method | Scopes |
|---|---|---|
| Access | POST | employee:signIn:writeemployee:signOut:write |
Form Entries (DVIR, Daily Driver Logs, etc.)
Various submitted forms, including post-sign in DVIRs ('sign_in.after'), pre-sign out DVIRs ('sign_out.before') and Daily Driver Logs ('vml').
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | formentry:read |
Plants
Plant data, including latitude and longitude location, geofence radius size or region edges, custom time zone information.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | plant:read |
Trucks
Current trucks data
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | truck:read |
Settings
Divisions
Divisions represent an organization structure that groups users and related resources into business or regional units.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | division:read |
Organization & Settings
Organization basic info, address details, and configurations.
| Permission | Method | Scopes |
|---|---|---|
| Read | GET | company:readcompany:configuration:read |