Data Models
Activity
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| date | string | ISO8601 formatted date | ✓ | |
| serviceId | string | A user provided ID to associate this activity with a specific service | ✓ | |
| customerId | string | A user provided ID to associate this activity with a specific customer | ✓ | |
| customerName | string | The customer's name | ✓ | |
| activityType | string | Type of activity. Activity Type | ✓ | ✓ |
| material | string | Type of material. Material | ✓ | ✓ |
| activityNotes | string | Comments from the customer or CSR relevant to the activity | ✓ | |
| nextActivity | string | The activityId of the activity to be performed in sequence after this activity | ✓ | |
| containers | list | List of Containers related to this activity | ✓ | |
| vehicleType | string | Default: rolloff | ✓ | |
| vehicleSize | string | The size of the vehicle needed for the service. Vehicle Sizes | ✓ | |
| hauler | object | The hauler assigned to the route | ✓ | |
| latitude | number | Latitude of the activity start location in Decimal Degrees | ✓ | ✓ |
| longitude | number | Longitude of the activity start location in Decimal Degrees | ✓ | ✓ |
| address | string | Street address | ✓ | ✓ |
| city | string | City name | ✓ | ✓ |
| state | string | State abbreviation | ✓ | ✓ |
| postalCode | string | Zip Code | ✓ | ✓ |
| timeWindowStart | string | ISO8601 formatted time representing the start of the allowable arrival time for the vehicle performing the activity. | ✓ | |
| timeWindowEnd | string | ISO8601 formatted time representing the end of the allowable arrival time for the vehicle performing the activity. | ✓ | |
| extraTime | number | Extra time in minutes to add to the expected activity duration | ✓ | |
| siteContact | string | The site Contact information for this particular activity. | ✓ | |
| routeId | string | The route the service has been assigned to | ✓ | |
| routeSequence | number | The position of this service relative to other services on the same route (e.g. 3 will be the third stop) | ✓ | |
| zone | string | The assigned zone for the service | ✓ | |
| plannedStart | string | ISO8601 formatted time representing the expected start time of the service according to the route plan | ✓ | |
| plannedEnd | string | ISO8601 formatted time representing the expected completion time of the service according to the route plan | ✓ | |
| plannedDuration | string | Time in minutes representing the expected duration of the service | ✓ | |
| actualStart | string | ISO8601 formatted time representing the actual start time of the service | ✓ | |
| actualEnd | string | ISO8601 formatted time representing the actual end time of the service | ✓ | |
| actualDuration | string | Time in minutes representing the actual duration of the service | ✓ | |
| status | string | The current status of the service. Activity Status | ✓ | |
| updateLatitude | number | Latitude (Decimal Degrees) of the driver when updating the activity | ✓ | |
| updateLongitude | number | Longitude (Decimal Degrees) of the driver when updating the activity | ✓ | |
| driverComments | string | Comments from the driver relevant to their completion of the service | ✓ | |
| createdAt | string | |||
| lastUpdated | string | |||
| workOrderId | string | The ID of a work order populated by the CRM. This will default to a blank string "". | ✓ |
Attachment
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| attachmentId | string | Generated ID of the Attachment | ||
| latitude | number | Latitude in WGS84 Decimal Degrees | ✓ | ✓ |
| longitude | number | Longitude in WGS84 Decimal Degrees | ✓ | ✓ |
| description | string | A description of the attachment | ✓ | |
| filename | string | The filename of the file in the attachment | ✓ | ✓ |
| originalFile | string | The S3 path were the original file is stored | ||
| smallThumbnail | string | The S3 path were a generated small thumbnail file is stored | ||
| createdAt | string | |||
| createdBy | string | |||
| updatedAt | string | |||
| updatedBy | string |
Contact
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| name | string | The name of the contact | ✓ | ✓ |
| phone | string | Primary phone to reach the contact at | ✓ | |
| string | Email address for the contact | ✓ |
Container
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| containerId | string | The ID of the container | ✓ | |
| plannedId | string | The ID of the container expected to be delivered or removed | ✓ | |
| type | string | The type of container | ✓ | ✓ |
| size | number | The size in yards of the container for the service. Values: 10, 12, 15, 20, 24, 30, 40 | ✓ | |
| activity | string | The action associated with this container. Must be either delivery or removal. | ✓ | ✓ |
Driver
| Name | Type | Description |
|---|---|---|
| driverId | string | A unique ID generated by rolloff360 |
| name | string | The driver's name |
| phone | string | The driver's daytime phone number |
| status | string | Controls if the driver is available for operating vehicles. Values: active or inactive |
| samsara_id | number | A unique ID for the driver generated by Samsara |
Facility
| Name | Type | Description |
|---|---|---|
| facilityId | string | A unique ID generated by rolloff360 |
| name | string | A descriptive name for this location |
| address | string | Street address |
| city | string | City name |
| state | string | State abbreviation |
| zip | string | Zip code |
| latitude | number | Latitude of the physical location in Decimal Degrees |
| longitude | number | Longitude of the physical location in Decimal Degrees |
| status | string | Controls if the location is included in route plans. Values: active or inactive |
| materials | string | Type of materials accepted Material Types |
| startEnd | boolean | Controls if fleet vehicles can start and end their routes at this location. |
| penalty | number | Additional factor to influence the preferredness of using this location as part of a route |
| duration | number | Time in hours representing the expected duration of a visit at this location |
| intermediate | boolean | Controls if fleet vehicles can use this location to dump material or replenish containers |
| containers | boolean | The location has container inventory |
Hauler
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| haulerId | string | A unique ID managed in Rolloff360 | ✓ | ✓ |
| name | string | The company name associated with the hauler | ✓ | ✓ |
| routeName | string | Default route name used by this hauler | ✓ |
Location
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| name | string | A descriptive name for the location | ✓ | |
| latitude | number | Latitude in WGS84 Decimal Degrees | ✓ | ✓ |
| longitude | number | Longitude in WGS84 Decimal Degrees | ✓ | ✓ |
Route
| Name | Type | Description | Required | Updatable |
|---|---|---|---|---|
| routeId | string | A unique ID generated by rolloff360 | ||
| date | string | ISO8601 formatted | ✓ | |
| name | string | A name for the route | ✓ | |
| vehicleType | string | Default: rolloff | ✓ | |
| vehicleSize | string | The size of the vehicle needed for the route Vehicle Sizes | ✓ | |
| vehicleId | string | The id of the vehicle assigned to the route | ✓ | |
| driverId | string | The id of the driver assigned to the route | ✓ | |
| hauler | object | The hauler assigned to the route | ✓ | |
| startLocation | object | A Location object for the starting location | ✓ | ✓ |
| endLocation | object | A Location object for the end location | ✓ | ✓ |
| plannedActivities | number | The number of activities originally assigned to the route | ||
| completedActivities | number | The number of activities completed by the route | ||
| plannedStart | string | ISO8601 formatted time representing the expected start time of the route | ✓ | |
| plannedEnd | string | ISO8601 formatted time representing the expected completion time of the route | ✓ | |
| plannedDuration | number | Time in minutes representing the expected duration of the route | ✓ | |
| actualStart | string | ISO8601 formatted time representing the actual start time of the route | ||
| actualEnd | string | ISO8601 formatted time representing the actual end time of the route | ||
| actualDuration | number | Time in minutes representing the actual duration of the route | ||
| plannedDistance | number | Distance in miles representing the expected travel distance of the route | ✓ | |
| actualDistance | number | Distance in miles representing the actual travel distance of the route | ✓ | |
| status | string | The current status of the route Route Status | ✓ | |
| zone | string | The assigned zone for the route | ✓ | |
| createdAt | string | |||
| lastUpdated | string |
Vehicle
| Name | Type | Description |
|---|---|---|
| vehicleId | string | A unique ID generated by rolloff360 |
| name | string | A short designator for the vehicle |
| size | string | The vehicle's size Vehicle Sizes |
| status | string | Controls if the vehicle is available for completing activities. Values: active or inactive |
| samsara_id | number | A unique ID for the vehicle generated by Samsara |
| settings | object | An object containing additional properties for the vehicle |
| driver | string | The name of the default driver assigned to the vehicle |
| start_lot | string | The name of the organization's facility that the vehicle will start its day at |
| end_lot | string | The name of the organization's facility that the vehicle should end its day at |
| start_time | string | ISO8601 formatted time representing the earliest time the vehicle is available |
| end_time | string | ISO8601 formatted time representing the latest time the vehicle is available |
| max_time | number | Time in hours representing the maximum duration the vehicle can be operational on a given day |