Skip to content
Bottle

Get planning settings

GET
/planning
curl --request GET \
  --url https://example.com/planning \
  --cookie bottle.session_token=<bottle.session_token>

The working day for any driver without hours of their own, how long loading takes, and what a stop costs on top of the drive to it. These turn a list of stops into a length of day, which is how a round is judged to fit a driver’s shift.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The settings

Media typeapplication/json
object
dayStart
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
dayEnd
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
breakMinutes
required
integer
<= 240
loadMinutes
required
integer
<= 240
stopMinutes
required
number
<= 120
itemMinutes
required
number
<= 60
trafficPercent
required
integer
<= 200
peakPercent
required
integer
<= 300
peakMorningFrom
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakMorningTo
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakEveningFrom
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakEveningTo
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
updatedAt
required
string format: date-time
Example
{
  "dayStart": "07:30",
  "dayEnd": "07:30",
  "peakMorningFrom": "07:30",
  "peakMorningTo": "07:30",
  "peakEveningFrom": "07:30",
  "peakEveningTo": "07:30"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}