Skip to main content

Project model

created_atstring<date-time>

Timestamp when the object has been created

data object

Optional arbitrary project data, primarily used by consuming applications (such as the web UI).

logistics_settings object

Settings for logistics applications.

allow_upload_after_simulation_start_timeboolean

If true, allows bookings to be uploaded even after the simulation has started.

Default value: false
can_manage_vehiclesboolean

UI setting to control vehicle management.

require_mark_all_ordersboolean

UI setting to require all orders to be marked.

use_solver_for_booking_assignmentsboolean

UI setting to use the solver for booking assignments.

public_holidaysobject

List of public holidays applicable to the project. Used to manage (and exclude) recurring simulation templates from recurrence for milk-run operations.

external_idnull

Arbitrary object ID.

idinteger

Project identifier

is_invalidatedboolean
latnumberrequired

Approximate latitude of the project to establish correct mapping and routing profiles for the project region

lonnumberrequired

Approximate longitutde of the project to establish correct mapping and routing profiles for the project region

modified_atstring<date-time>

Last time the object was modified.

namestringrequired

Project name

timezonestringrequired

Timezone of the project

notifications object

Flag allowing to enable notifications like SMS for the user for this project

delivery_on_the_wayboolean

Delivery on the way notification. Triggered when a booking's state changes to: PREPARED, QUEUED, CALCULATION, ASSIGNED, or SENT_OFFER.

operation_start_timestring<time>

Timestamp for notifications to be sent out from

found_a_rideboolean

Occurs when the system finds an offer after the user presses the 'Book' button.

vehicle_arrivalboolean

Occurs when the driver presses the 'Arrive' button for the pickup stop.

failed_to_boardboolean

Occurs when the driver presses 'Go to the next stop', but the passenger did not board.

offer_acceptanceboolean

Occurs the passenger accepts the offer

vehicle_eta_pickupboolean
vehicle_eta_dropoffboolean
settings object
logistics_geocoding_reject_multiple_results_per_addressboolean

If the geocoding engine returns multiple options for the same address, this setting controls the behavior. If set to true, multiple resolutions will fail the request. If set to false, the resolution with the highest score will be selected. This configuration is applied during booking upload as part of the automatic geocoding process.

Default value: false
logistics_geocoding_score_thresholdnumber

Configures the quality score threshold for geocoding. If the score is above the threshold, the geocoding will be successful; otherwise, it will fail. This configuration is applied during booking upload as part of the automatic geocoding process.

Possible values: >= 0 and <= 1

bookingprogress_v2_order_tracking_enabledboolean

Enables or disables anonymous access to order tracking information for the project.

Default value: false
mapbox_style_url object

Defines map styles to be used by SWAT Driver App

light_themestring

Mapbox URL style for light theme, e.g. mapbox://styles/njachowski/cledzgtfw000v01mlfquerbox

dark_themestring

Mapbox URL style for dark theme, e.g. mapbox://styles/njachowski/cledzgtfw000v01mlfquerbox

Project model
{
  "created_at": "2024-07-29T15:51:28.071Z",
  "data": {
    "logistics_settings": {
      "allow_upload_after_simulation_start_time": false,
      "can_manage_vehicles": true,
      "require_mark_all_orders": true,
      "use_solver_for_booking_assignments": true
    },
    "public_holidays": {}
  },
  "external_id": "null",
  "id": 0,
  "is_invalidated": true,
  "lat": 0,
  "lon": 0,
  "modified_at": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "timezone": "string",
  "notifications": {
    "delivery_on_the_way": true,
    "operation_start_time": "string",
    "found_a_ride": true,
    "vehicle_arrival": true,
    "failed_to_board": true,
    "offer_acceptance": true,
    "vehicle_eta_pickup": true,
    "vehicle_eta_dropoff": true
  },
  "settings": {
    "logistics_geocoding_reject_multiple_results_per_address": false,
    "logistics_geocoding_score_threshold": 0,
    "bookingprogress_v2_order_tracking_enabled": false,
    "mapbox_style_url": {
      "light_theme": "string",
      "dark_theme": "string"
    }
  }
}
Last updated on