[EXPERIMENTAL] Upsert PartialRoute

Request

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

Security

clientCredentials

Path

business_idstring^[a-zA-Z0-9.~\-_]{1,512}$required

The business identifier of an entity instance

If-Matchstring

weak Etag as optimistic locking check

Bodyapplication/json

plan_groupstring

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

Example:"a plan group"

same_route_groupstring

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

Example:"route-group-01"

requirementsobject(Requirements)

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

labelsArray of strings, unique

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

Default:[]

Example:

[
  "labelA"
]

stopsArray of objects, non-empty, unique(Stop)required

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.

breaksArray of objects(Break)

Default:[]

Payload

{
  "plan_group": "a plan group",
  "same_route_group": "route-group-01",
  "requirements": {
    "tags": [],
    "forbidden_tags": []
  },
  "labels": [],
  "stops": [
    { … }
  ],
  "breaks": []
}

Responses

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

Headers

ETagstring

weak Etag (ex W/<etag_value>) which contains the (updated) version of the entity

Preference-Appliedstring

to indicate whether a preference has been applied. (ex Preference-Applied: return=representation)

Locationstring

contains the URI to the entity

Bodyapplication/json

business_idstring^[a-zA-Z0-9.~\-_]{1,512}$read-onlyrequired

Unique identifier for this PartialRoute.

Example:"PPT-1"

plan_groupstring

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

Example:"a plan group"

same_route_groupstring

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

Example:"route-group-01"

requirementsobject(Requirements)

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

labelsArray of strings, unique

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

Default:[]

Example:

[
  "labelA"
]

stopsArray of objects, non-empty, unique(Stop)required

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.

breaksArray of objects(Break)

Default:[]

Response

{
  "business_id": "PPT-1",
  "plan_group": "a plan group",
  "same_route_group": "route-group-01",
  "requirements": {
    "tags": [],
    "forbidden_tags": []
  },
  "labels": [],
  "stops": [
    { … }
  ],
  "breaks": []
}