Skip to content
Bottle

Work out what the owner means

POST
/rounds/learned/understand
curl --request POST \
  --url https://example.com/rounds/learned/understand \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "answer": "example" }'

Works out what the owner’s typed words mean for planning, for them to check. Sends a model those words and the names and ids of only the customers, addresses, drivers and vehicles they seem to mention. Keeps nothing, unless the caller sends an Idempotency-Key, when the reply is held for a week so it can be sent again.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
answer
required
string
>= 1 characters <= 2000 characters

Example generated

{
  "answer": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

What was understood, for the owner to check

Media typeapplication/json
object
items
required
Array<object>
object
kind
required
string
Allowed values: prefer_driver time_window avoid_weekday service_time run_order reserve_load note
scopeType
required
string
Allowed values: business customer address driver vehicle area
scopeId
required
string | null
<= 200 characters
effect
statement
required
string
>= 1 characters <= 500 characters
where
string | null
leftOut
required
Array<object>
object
reason
required
string
Allowed values: sensitive contactDetails
word
required
string | null
read
required
boolean

Example 

{
  "items": [
    {
      "kind": "prefer_driver",
      "scopeType": "business"
    }
  ],
  "leftOut": [
    {
      "reason": "sensitive"
    }
  ]
}

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 the owner in the office app, or on a plan without rounds

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The words can’t be kept, with the reason

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"
    }
  ]
}