ReDoc documentation

Partial Routes [EXPERIMENTAL]

[EXPERIMENTAL] [UNDER DEVELOPMENT] Endpoints for managing preplanned PartialRoutes.

[EXPERIMENTAL] Upsert PartialRoute

[EXPERIMENTAL] Upsert a PartialRoute defined by a business id.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

header Parameters
If-Match
string

weak Etag as optimistic locking check

Request Body schema: application/json
plan_group
string

The (optional) plan group this PartialRoute belong to. Plan Groups can be used for filtering the data included in a logistical optimization.

route_group
string

The (optional) route group this PartialRoute belongs to. All PartialRoutes within a route_group must share the same executor, ie: they will belong to the same route.

object (Requirements)

The requirements that need to be fulfilled for this PartialRoute to be considered feasible for an executor in a logistical optimization.

labels
Array of strings unique
Default: []

Labels can be used for identifying sets of PartialRoutes, or Orders within these PartialRoutes.

required
Array of objects (Stop) non-empty unique

A Stop has a specific location where one or more pickups or deliveries need to be made, taking into account the timings for a stop.

Array of objects (Break)
Default: []
Responses
201

PartialRoute created or updated, when the Prefer header was set to return=representation.

204

PartialRoute created or updated, when the Prefer header was set to return=minimal.

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

put/preplanned/partial-routes/{business_id}
Request samples
application/json
{
  • "plan_group": "a plan group",
  • "route_group": "route-group-01",
  • "requirements": {
    },
  • "labels": [ ],
  • "stops": [
    ],
  • "breaks": [ ]
}
Response samples
application/json
{
  • "business_id": "PPT-1",
  • "plan_group": "a plan group",
  • "route_group": "route-group-01",
  • "requirements": {
    },
  • "labels": [ ],
  • "stops": [
    ],
  • "breaks": [ ]
}

[EXPERIMENTAL] Get PartialRoute

[EXPERIMENTAL] Get a PartialRoute by a business id.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

Responses
200

OK

404

The entity is not found

get/preplanned/partial-routes/{business_id}
Response samples
application/json
{
  • "business_id": "PPT-1",
  • "plan_group": "a plan group",
  • "route_group": "route-group-01",
  • "requirements": {
    },
  • "labels": [ ],
  • "stops": [
    ],
  • "breaks": [ ]
}

[EXPERIMENTAL] Delete PartialRoute

[EXPERIMENTAL] Delete a PartialRoute by a business id.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

header Parameters
If-Match
string

weak Etag as optimistic locking check

Responses
204

Deletion has succeeded and body is empty

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

delete/preplanned/partial-routes/{business_id}
Response samples
application/problem+json
{}