# Get cursor-based transport resources

Retrieve transport resources in bulk using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal).

Endpoint: GET /transport-resource
Version: 1.27.2
Security: clientCredentials

## Query parameters:

  - `cursor` (string)
    The cursor of the page to return. No cursor is expected for the initial request. The cursors returned by this endpoint can be used for subsequent requests.

  - `limit` (integer)
    Number of results to return per page.

## Response 200 fields (application/json):

  - `data` (array)
    The set of results for the current page.

  - `data.business_id` (string, required)
    Example: "tractor-1"

  - `data.type` (string, required)
    A TRACTOR is a pulling  unit, a TRAILER a cargo unit and a TRUCK is both a pulling and cargo unit.
    Enum: "TRACTOR", "TRAILER", "TRUCK"

  - `data.license_plate` (string)
    Example: "1-ABC-987"

  - `data.requirements` (array)
    List of requirements the Employee must fulfill to be allowed to use this TransportResource.
    Example: ["driving license CE"]

  - `data.capabilities` (array)
    Capabilities this TransportResource provides to the ResourceCombination.
    Example: ["big bag"]

  - `data.required_capabilities` (array)
    List of requirements the Employee must fulfill, which will be provided as capabilities to the ResourceCombination.
    Example: ["cooling compressor"]

  - `data.skilled_capabilities` (array)
    List of capabilities which will be provided to the ResourceCombination, if the Employee has matching driver_skills.
    Example: ["sideloading"]

  - `data.cant_do` (array)
    List of capabilities which will be disabled on the resulting ResourceCombination.
For example: A TRACTOR with a faulty electric plug, can not be used with a TRAILER that exposes a capability which requires this plug.
    Example: ["adr-transport"]

  - `data.capacities` (array)
    These capacities mirror the Order Book capacities.

  - `data.capacities.type` (string)
    characterization of a capacity, default volume
    Enum: "volume", "weight", "loadingMeters", "capacity1", "capacity2", "capacity3", "capacity4", "capacity5"

  - `data.capacities.value` (number, required)
    Example: 20.02

  - `data.linked_resource` (string)
    The business_id of another TransportResource on the same location that should be coupled with this one no matter what.
This is known as a fixed coupling.

By using this you can indicate that a tractor should always be coupled with a specific trailer (or the other way around).
There is no need to specify the linking in both directions.
This overwrites all requirements and as such could lead to seemingly invalid situations, but this is at the discretion of the planner.
    Example: "trailer-1"

  - `data.start_location` (object)
    The start_location where this TransportResource is based.

Either address information or geo point must be provided. The resolved information will be read only and be filled out after resolving. 

Either a home_base or a start_location must be provided.

  - `data.start_location.name` (string, required)
    A name by which to identify this location. If used as a start_location, this is used for matching colocated entities.
    Example: "Conundra"

  - `data.start_location.address_line` (string)
    The address line of this location's address. Can contain street, house number, bus and more.
    Example: "Voordries 41b"

  - `data.start_location.city` (string)
    The name of the locality of this location.

Required when no geo_point is provided.
    Example: "Oosterzele"

  - `data.start_location.zip_code` (string)
    The ZIP code of the locality of this location.

Required when no geo_point is provided.
    Example: "9860"

  - `data.start_location.country_code` (string)
    The ISO3166-1 alpha-2 two letter country code for this location.

Required when no geo_point is provided.

  - `data.start_location.geo_point` (object)

  - `data.start_location.geo_point.latitude` (number, required)
    Example: 50.9514048

  - `data.start_location.geo_point.longitude` (number, required)
    Example: 3.8067878

  - `data.start_location.geo_point.resolved` (object)
    Indicates whether the address is resolved.

  - `data.start_location.geo_point.resolved.geocoded` (boolean)
    Example: true

  - `data.start_location.geo_point.resolved.address` (string)
    Example: "Voordries 31 bus B, 9860 Oosterzele"

  - `data.start_location.geo_point.resolved.precision` (integer)
    Example: 9

  - `data.home_base` (object)
    Conceptually the same as start_location, but with centralized address management.

Either a home_base or a start_location must be provided.

  - `data.home_base.business_id` (string, required)
    The unique identifier of a HomeBase.
    Example: "depot-1"

  - `data.reference` (string)
    Optional, internal reference (eg: fleet number, ...) for the TransportResource.
    Example: "fleet-reference-47"

  - `data.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 Resource Management, but can be used to 
enrich the data in OptiFlow with relevant information for the end users.    

Keys should not be blank nor contain periods.

  - `data.labels` (array)
    Labels provided by the TransportResource for its Combination.
    Example: ["Transport-resource-label-A"]

  - `data.inactive` (boolean)
    Flag to indicate whether a TransportResource can be used for creating ResourceCombinations. When set to true, all future ResourceCombinations will be removed.

  - `data.cost` (object)

  - `data.cost.per_kilometer` (number)
    A cost to be applied per kilometer in the optimization when utilizing this resource.
    Example: 0.9

  - `data.cost.per_hour` (number)
    An hourly cost to be applied in the optimization when utilizing this resource.
    Example: 46.8

  - `data.cost.fixed` (number)
    The fixed cost to be applied in the optimization when utilizing this resource.
    Example: 213

  - `data.characteristics` (object)
    [EXPERIMENTAL]
Technical characteristics of this TransportResource.

  - `data.characteristics.maximum_allowed_weight` (number)
    The maximum allowed weight for this cargo unit.
This cannot be provided for transport resources of type TRACTOR.
    Example: 3500

  - `data.route_settings` (object)
    Route settings for this TransportResource.

  - `data.route_settings.direct_trips` (boolean, required)
    Restricts this TransportResource to direct trips during planning.

  - `data.etag` (string)
    Example: "W/\"25\""

  - `cursors` (object)
    The cursors represent pointers to pages of results in relation to the page that was retrieved by the current request. These pointers are nullable. For more information
on these pointers, view the Developer Portal.

  - `cursors.previous` (string)
    Pointer to the previous page of results.

  - `cursors.self` (string)
    Pointer to the current page of results. When changing the limit in subsequent requests, the first 'limit' results will be contained in the page.

  - `cursors.next` (string)
    Pointer to the next page of results.

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

  - `title` (string)
    A short, summary of the problem.
    Example: "Validation exception"

  - `detail` (string)
    A detailed explanation specific to this problem.
    Example: "The field contains invalid business formatting."

  - `violations` (array)

  - `violations.field` (string)
    Example: "path.to.field"

  - `violations.message` (string)
    Example: "Field is required"


## Response 401 fields