Upsert Transport Resource

Request

Upsert a single TransportResource.

As a TransportResource is considered to be always available unless a TransportResourceUnavailability says otherwise, its presence will result in the application trying to create ResourceCombinations by matching AvailableEmployees with this TransportResource.

Security

clientCredentials

Path

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

A unique identifier of an entity instance. Should only contain characters which do not need URL encoding.

PreferArray of strings

The RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).

The following behavior (see Examples) is supported by this API:

return=<minimal|representation> is used to suggest the server to return using 204 without resource (minimal) or using 200 or 201 with resource (representation) in the response body on success.

Examples:

minimal

Indicate no response is needed, can be omitted

["return=minimal"]

representation

Request the result of the operation as response

["return=representation"]

If-Matchstring

Weak Etag used for optimistic locking.

Example:W/"24"

Bodyapplication/json

typestring(ResourceType)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"

Example:"TRACTOR"

license_platestring

Example:"1-ABC-987"

requirementsArray of strings, unique

List of requirements the Employee must fulfill to be allowed to use this TransportResource.

Example:

[
  "driving license CE"
]

capabilitiesArray of strings, unique

Capabilities this TransportResource provides to the ResourceCombination. Note: if a capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization.

Example:

[
  "big bag"
]

required_capabilitiesArray of strings, unique

List of requirements the Employee must fulfill, which will be provided as capabilities to the ResourceCombination. Note: if a required capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization.

Example:

[
  "cooling compressor"
]

skilled_capabilitiesArray of strings, unique

List of capabilities which will be provided to the ResourceCombination, if the Employee has matching driver_skills. Note: if a skilled capability contains a dash, it will be split into two capabilities upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization.

Example:

[
  "sideloading"
]

cant_doArray of strings, unique

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

capacitiesArray of objects, [ 1 .. 8 ] items, unique(Capacity)

These capacities mirror the Order Book capacities.

linked_resourcestring

The 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"

start_locationobject(NamedGeoAddress)

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.

home_baseobject(LinkedHomeBase)

Conceptually the same as start_location, but with centralized address management.

Either a home_base or a start_location must be provided.

referencestring

Optional, internal reference (eg: fleet number, ...) for the TransportResource.

Example:"fleet-reference-47"

custom_dataobject(CustomData)

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.

Example:

{
  "shop_manager": "John Smith"
}

labelsArray of strings

Labels provided by the TransportResource for its Combination. Note: if a label contains a dash, it will be split into two labels upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization.

Example:

[
  "Transport-resource-label-A"
]

inactiveboolean

Flag to indicate whether a TransportResource can be used for creating ResourceCombinations. When set to true, all future ResourceCombinations will be removed.

Default:false

costobject(Cost)

characteristicsobject(Characteristics)

[EXPERIMENTAL] Technical characteristics of this TransportResource.

route_settingsobject(RouteSettings)

Route settings for this TransportResource.

Payload

{
  "type": "TRACTOR",
  "license_plate": "1-ABC-987",
  "requirements": [
    "driving license CE"
  ],
  "capabilities": [
    "big bag"
  ],
  "required_capabilities": [
    "cooling compressor"
  ],
  "skilled_capabilities": [
    "sideloading"
  ],
  "cant_do": [
    "adr-transport"
  ],
  "capacities": [
    { … }
  ],
  "linked_resource": "trailer-1",
  "start_location": {
    "name": "PTV Logistics",
    "address_line": "Voordries 41b",
    "city": "Oosterzele",
    "zip_code": "9860",
    "country_code": "BE",
    "geo_point": { … }
  },
  "home_base": {
    "business_id": "depot-1",
    "id": "depot-1"
  },
  "reference": "fleet-reference-47",
  "custom_data": {
    "shop_manager": "John Smith"
  },
  "labels": [
    "Transport-resource-label-A"
  ],
  "inactive": false,
  "cost": {
    "per_kilometer": 0.9,
    "per_hour": 46.8,
    "fixed": 213
  },
  "characteristics": {
    "maximum_allowed_weight": 3500
  },
  "route_settings": {
    "direct_trips": false
  }
}

Responses

Transport Resource created or updated

Headers

ETagstring

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

Example:"W/\"25\""

Preference-Appliedstring

Indicates whether a preference has been applied. (ex return=representation)

Locationstring, (URI)

A URI to access the result of the operation.

Bodyapplication/json

idstring^[a-zA-Z0-9.~\-_]+$read-onlyrequired

Unique identifier for this TransportResource.

Example:"tractor-1"

typestring(ResourceType)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"

Example:"TRACTOR"

license_platestring

Example:"1-ABC-987"

requirementsArray of strings, unique

List of requirements the Employee must fulfill to be allowed to use this TransportResource.

Example:

[
  "driving license CE"
]

capabilitiesArray of strings, unique

Example:

[
  "big bag"
]

required_capabilitiesArray of strings, unique

Example:

[
  "cooling compressor"
]

skilled_capabilitiesArray of strings, unique

Example:

[
  "sideloading"
]

cant_doArray of strings, unique

Example:

[
  "adr-transport"
]

capacitiesArray of objects, [ 1 .. 8 ] items, unique(Capacity)

These capacities mirror the Order Book capacities.

linked_resourcestring

The 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.

Example:"trailer-1"

start_locationobject(NamedGeoAddress)

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.

home_baseobject(LinkedHomeBase)

Conceptually the same as start_location, but with centralized address management.

Either a home_base or a start_location must be provided.

referencestring

Optional, internal reference (eg: fleet number, ...) for the TransportResource.

Example:"fleet-reference-47"

custom_dataobject(CustomData)

Keys should not be blank nor contain periods.

Example:

{
  "shop_manager": "John Smith"
}

labelsArray of strings

Example:

[
  "Transport-resource-label-A"
]

inactiveboolean

Flag to indicate whether a TransportResource can be used for creating ResourceCombinations. When set to true, all future ResourceCombinations will be removed.

Default:false

costobject(Cost)

characteristicsobject(Characteristics)

[EXPERIMENTAL] Technical characteristics of this TransportResource.

route_settingsobject(RouteSettings)

Route settings for this TransportResource.

business_idstring^[a-zA-Z0-9.~\-_]+$read-onlyrequireddeprecated

Unique identifier for this TransportResource. Deprecated in favor of id.

Example:"tractor-1"

Response

{
  "business_id": "tractor-1",
  "id": "tractor-1",
  "type": "TRACTOR",
  "license_plate": "1-ABC-987",
  "requirements": [
    "driving license CE"
  ],
  "capabilities": [
    "big bag"
  ],
  "required_capabilities": [
    "cooling compressor"
  ],
  "skilled_capabilities": [
    "sideloading"
  ],
  "cant_do": [
    "adr-transport"
  ],
  "capacities": [
    { … }
  ],
  "linked_resource": "trailer-1",
  "start_location": {
    "name": "PTV Logistics",
    "address_line": "Voordries 41b",
    "city": "Oosterzele",
    "zip_code": "9860",
    "country_code": "BE",
    "geo_point": { … }
  },
  "home_base": {
    "business_id": "depot-1",
    "id": "depot-1"
  },
  "reference": "fleet-reference-47",
  "custom_data": {
    "shop_manager": "John Smith"
  },
  "labels": [
    "Transport-resource-label-A"
  ],
  "inactive": false,
  "cost": {
    "per_kilometer": 0.9,
    "per_hour": 46.8,
    "fixed": 213
  },
  "characteristics": {
    "maximum_allowed_weight": 3500
  },
  "route_settings": {
    "direct_trips": false
  }
}