# [EXPERIMENTAL] Get PartialRoute

[EXPERIMENTAL] Get a PartialRoute by a business id.

Endpoint: GET /preplanned/partial-routes/{business_id}
Version: 1.6.1
Security: clientCredentials

## Path parameters:

  - `business_id` (string, required)
    The business identifier of an entity instance

## Response 200 fields (application/json):

  - `business_id` (string, required)
    Unique identifier for this PartialRoute.
    Example: "PPT-1"

  - `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.
    Example: "a plan group"

  - `same_route_group` (string)
    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"

  - `requirements` (object)
    The requirements that need to be fulfilled for this PartialRoute to be considered feasible for an executor in a logistical optimization.

  - `requirements.tags` (array)
    Properties that MUST be present on the executor.
    Example: ["tagX"]

  - `requirements.forbidden_tags` (array)
    Properties that MUST NOT be present on the executor.
    Example: ["tagY"]

  - `labels` (array)
    Labels can be used for identifying sets of PartialRoutes, or Orders within these PartialRoutes.
    Example: ["labelA"]

  - `stops` (array, 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.

  - `stops.visit_location` (object, required)
    Either address information should be present, or otherwise the geo point. The resolved information will be read-only and be filled out after resolving.

  - `stops.visit_location.name` (string)
    A name by which to identify this location
    Example: "Conundra"

  - `stops.visit_location.address_line` (string)
    The address line for this location's address.
    Example: "Voordries 41"

  - `stops.visit_location.city` (string)
    The city of this location.

Required when no geo point is provided.
    Example: "Oosterzele"

  - `stops.visit_location.zip_code` (string)
    The zip code of this location.

Required when no geo point is provided.
    Example: "9860"

  - `stops.visit_location.country_code` (string)
    An ISO3166-1 alpha-2 two letter country code.

Required when no geo point is provided.

  - `stops.visit_location.geo_point` (object)
    The geo point identifying this location. If this is provided, all textual address information is optional.

  - `stops.visit_location.geo_point.latitude` (number, required)
    Example: 50.9514048

  - `stops.visit_location.geo_point.longitude` (number, required)
    Example: 3.8067878

  - `stops.visit_location.resolved_address` (object)
    The resolved address is geocoded based on the given address, with the quality of the resolving being specified by the field score.

Addresses are only resolved when no geo point is provided on the provided address.

  - `stops.visit_location.resolved_address.geo_point` (object)

  - `stops.visit_location.resolved_address.address_line` (string)
    Example: "Voordries 41"

  - `stops.visit_location.resolved_address.city` (string)
    Example: "Oosterzele"

  - `stops.visit_location.resolved_address.zip_code` (string)
    Example: "9860"

  - `stops.visit_location.resolved_address.country_code` (string)
    An ISO3166-1 alpha-2 two letter country code

  - `stops.visit_location.resolved_address.score` (integer)
    This score ranges from 0 to 9, with 0 being the worst and 9 a perfectly geocoded address.
    Example: 9

  - `stops.pickups` (array)

  - `stops.pickups.order` (object, required)

  - `stops.pickups.order.business_id` (string, required)
    Unique identifier for this Pickup. This must match the business_id for the corresponding Delivery in this PartialRoute.
    Example: "Order-1"

  - `stops.pickups.order.capacities` (array)

  - `stops.pickups.order.capacities.type` (string)
    Characterization of a capacity, representing the dimension in which this Capacity is expressed.
    Enum: "volume", "weight", "loadingMeters", "capacity1", "capacity2", "capacity3", "capacity4", "capacity5"

  - `stops.pickups.order.capacities.value` (number, required)
    The nominal capacity required of the executor, in the specified dimension.
    Example: 20

  - `stops.pickups.order.requirements` (object)
    Requirements that have to be fulfilled by the executor of an order at this location.

  - `stops.pickups.order.labels` (array)
    Labels can be used for identifying sets of Orders within a logistical optimization.
    Example: ["labelA"]

  - `stops.pickups.order.description` (string)

  - `stops.pickups.order.custom_data` (object)
    Custom data is an extendable hashmap of key-value pairs for client usage. These values have no meaning in the context of Order Book, but can be used to 
enrich the data in Order Book with relevant information for the end users.

  - `stops.pickups.timings` (object, required)

  - `stops.pickups.timings.start_at` (string, required)
    The planned time of start for this activity. 

Must be provided as an ISO-8601 formatted datetime.
    Example: "2021-01-01T10:15:30Z"

  - `stops.pickups.timings.service_time` (string, required)
    The duration required for executing this activity.

Must be an ISO-formatted Duration, see [wikipedia ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) and [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339). Must be non negative.
    Example: "PT5M"

  - `stops.deliveries` (array)

  - `breaks` (array)

  - `breaks.at` (string, required)
    The planned start time of this Break
    Example: "2021-01-01T10:15:30Z"

  - `breaks.duration` (string, required)
    The duration of this Break.

Must be an ISO-formatted Duration, see [wikipedia ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) and [RFC-3339](https://datatracker.ietf.org/doc/html/rfc3339). Must be non negative.
    Example: "PT8H"

## Response 404 fields (application/problem+json):

  - `type` (string)
    An absolute URI that identifies the problem type.  When dereferenced,
it SHOULD provide human-readable documentation for the problem type
(e.g., using HTML).
    Example: "https://api.conundra.eu/problem/constraint-violation"

  - `title` (string)
    A short, summary of the problem type. Written in english and readable
for engineers (usually not suited for non technical stakeholders and
not localized); example: Service Unavailable
    Example: "Invalid ..."

  - `status` (integer)
    The HTTP status code generated by the origin server for this occurrence
of the problem.
    Example: 400

  - `detail` (string)
    A human readable explanation specific to this occurrence of the
problem.
    Example: "string"

  - `instance` (string)
    An absolute URI that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.
    Example: "https://api.conundra.eu/orderbook/v1/orders/deliveries/chilled"

  - `violations` (array)

  - `violations.field` (string)
    A reference to the field in the request that triggered this violation.
    Example: "class.field"

  - `violations.message` (string)
    A message explaining the violation in the referenced field.
    Example: "a violation message"