Skip to content
Resource Planner [BETA]/
/
Changelog
Last updated

Resource Management API Changelog

Version 1.30.1

  • Added documentation note about dash-splitting behavior upon exporting and re-importing the vehicle set in PTV OptiFlow Route Optimization to the following fields: Employee.driver_skills, Employee.skills, Employee.labels, TransportResource.capabilities, TransportResource.required_capabilities, TransportResource.skilled_capabilities, TransportResource.labels.

Version 1.30.0

  • Added optimistic locking support to Deployment endpoints via If-Match and ETag headers

Version 1.29.0

  • Deprecated business_id in favor of a new id field on Employee, Actual, HomeBase, and TransportResource schemas.

Version 1.28.0

  • Resolved unclarity surrounding entities that can be created with both a generated ID as a user-provided ID.
    ⚠️ This might require integrations to update references to these path variables in integrations that are based on generated clients.
    • Employee Unavailability
    • TransportResource Unavailability

Version 1.27.2

  • Version was incorrectly modeled as a string while it is an integer. The spec now correctly models version as an Integer.

Version 1.27.1

  • Added missing If-Match and Prefer headers to the HomeBase endpoints

Version 1.27.0

  • Removed deployed_at from deployment response

Version 1.26.8

  • Change DataType of max_stops_per_shift on an Employees Route Settings to integer.

Version 1.26.7

  • change DataType of cursor limit to integer

Version 1.26.6

  • edited the descriptions for Deployments to better clarify the difference between Deployments originating from PTV OptiFlow and externally managed Deployments.

Version 1.26.5

  • Document max length of business_id's is 512

Version 1.26.4

  • Change description of Costs to reflect we round to a precision of 4
  • Add requirements for ShiftSchedule#start-properties

Version 1.26.3

  • Change description of Costs to reflect we round to a precision of 4

Version 1.26.2

  • Make the deployment API experimental to reflect that it is still under active development

Version 1.26.1

  • Added endpoints to manage External Deployments
  • Added endpoints to query Deployments

Version 1.26.0

  • Added endpoints to manage External Deployments
  • Added endpoints to query Deployments

Version 1.25.1

  • Enable route_settings on TransportResources to configure direct_trips

Version 1.25.0

  • Enable route_settings on TransportResources to configure direct_trips

Version 1.24.1

  • flag ShiftSchedule#templates#shifts as required to reflect the actual validation rules

Version 1.24.0

  • introduced experimental route_settings for the Employee
  • moved experimental property driving_speed_factor to route_settings
  • introduced experimental property max_stops_per_shift to route_settings

Version 1.23.0

  • add optional end to EmployeeActual

Version 1.22.0

  • add cursor-based GET endpoints for HomeBase, TransportResource and EmployeeActual

Version 1.21.0

  • Change version to eTag in the Get cursor-based Employee endpoint

Version 1.20.0

  • Add Get cursor-based Employee endpoint

Version 1.19.1

  • rename security scheme

Version 1.19.0

  • add support for AtLastEnd StartLocation on a Shift

Version 1.18.1

  • Revert same_as_start property on EndLocation as this is a breaking change for the GET endpoints.

Version 1.18.0

  • The start window of a Shift within a ShiftSchedule can be greater than PT6H.

Version 1.17.0

  • The start window of a Shift within a ShiftSchedule can be greater than PT6H.

Version 1.16.0

  • Add flag for start at last end to Employee Availabilities

Version 1.15.2

  • Documented ID format constraints

Version 1.15.1

  • Document deprecated Availability start location fields.

Version 1.15.0

  • Add means/actuals endpoint. [EXPERIMENTAL]

Version 1.14.0

  • Add acceptable_additional_work_time and contractual_work_time to Shift Schedule. [EXPERIMENTAL]

Version 1.13.0

  • Add end_location to Employee Availability. [EXPERIMENTAL]
  • Support end_location atLastActivity. [EXPERIMENTAL]

Version 1.12.0

  • Add end_location to Employee Availability. [EXPERIMENTAL]

Version 1.11.0

  • Add driving_speed_factor to Employee. [EXPERIMENTAL]

Version 1.10.0

  • Add plan_group to HomeBase.

Version 1.9.1

  • Add start_location to Shift response
  • Add documentation to Transport Resource schema and endpoints
  • Add documentation to Home Base schema and endpoints
  • Exclude version from ShiftSchedule POST and PUT responses

Version 1.9.0

  • Add start_location to Shift response
  • Add documentation to Transport Resource schema and endpoints
  • Add documentation to Home Base schema and endpoints

Version 1.8.3

  • Added extra documentation for Availability
  • Groups tags by functional boundary
  • Add documentation to Employee schema and endpoints
  • Add documentation to ShiftSchedule schema and endpoints
  • Add documentation to Availability schema and endpoints
  • Documented version attribute present on ShiftSchedule schema

Version 1.8.2

  • Added extra documentation for Availability
  • Groups tags by functional boundary
  • Add documentation to Employee schema and endpoints
  • Add documentation to ShiftSchedule schema and endpoints
  • Add documentation to Availability schema and endpoints
  • Add documentation to Forecast schema and endpoints
  • Add documentation to Unavailability schema and endpoints

Version 1.0.0

  • Release version 1.0.0 and removed disclaimer
  • Introduce and clarify Experimental API endpoints
  • ANY /employee-pool/{business_id}
  • GET /employee/{business_id}/shift-schedule/{generated_id}
  • ANY /employee/{business_id}/shift-schedule/availabilities
  • ANY /resource-overview

Version 0.14.0

  • Remove EmployeeAvailabilities PUT call

Version 0.13.11

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters
  • Add ShiftScheduleStart to ShiftSchedule
  • Remove start_index parameter from preview and expand shift schedule
  • Rename at_least_until to to for preview and expand shift schedule
  • Add labels to Employee in ResourceOverview
  • Make start mandatory for ShiftSchedule

Version 0.13.10

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters
  • Add ShiftScheduleStart to ShiftSchedule
  • Remove start_index parameter from preview and expand shift schedule
  • Rename at_least_until to to for preview and expand shift schedule
  • Add labels to Employee in ResourceOverview

Version 0.13.9

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters
  • Add ShiftScheduleStart to ShiftSchedule
  • Remove start_index parameter from preview and expand shift schedule
  • Rename at_least_until to to for preview and expand shift schedule

Version 0.13.8

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters
  • Add ShiftScheduleStart to ShiftSchedule
  • Remove start_index parameter from preview and expand shift schedule

Version 0.13.7

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters
  • Add ShiftScheduleStart to ShiftSchedule

Version 0.13.6

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview
  • Fixed ResourceOverview path parameters changed to query parameters

Version 0.13.5

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview
  • Add mandatory to Availability, Shift and ResourceOverview

Version 0.13.4

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview
  • Add labels to available Employee and ResourceCombination in ResourceOverview

Version 0.13.3

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview
  • Add available Employee reference to ResourceOverview

Version 0.13.2

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource
  • Add Cost to ResourceOverview

Version 0.13.1

  • Add Cost configuration to Employee
  • Add Cost configuration to TransportResource

Version 0.13.0

  • Add Cost configuration to Employee

Version 0.12.2

  • Resource Overview API: first increment, including assigned combinations
  • Resource Overview API: second increment, including available employees
  • Resource Overview API: third increment, including scheduled employees

Version 0.12.1

  • Resource Overview API: first increment, including assigned combinations
  • Resource Overview API: second increment, including available employees

Version 0.12.0

  • Resource Overview API: first increment, including assigned combinations

Version 0.11.4

  • Remove EmployeeAvailabilities PUT
  • Remove X-Conundra-Availability header for Availabilities V2 PUT
  • Add GET endpoint to preview Availabilities for a ShiftSchedule
  • Add POST endpoint to expand Availabilities for a ShiftSchedule
  • Add optional query parameters to GET Availabilities endpoint
  • Add DELETE Availabilities endpoint with optional query parameters

Version 0.11.3

  • Remove EmployeeAvailabilities PUT
  • Remove X-Conundra-Availability header for Availabilities V2 PUT
  • Add GET endpoint to preview Availabilities for a ShiftSchedule
  • Add POST endpoint to expand Availabilities for a ShiftSchedule
  • Add optional query parameters to GET Availabilities endpoint

Version 0.11.2

  • Remove EmployeeAvailabilities PUT
  • Remove X-Conundra-Availability header for Availabilities V2 PUT
  • Add GET endpoint to preview Availabilities for a ShiftSchedule
  • Add POST endpoint to expand Availabilities for a ShiftSchedule

Version 0.11.1

  • Remove EmployeeAvailabilities PUT
  • Remove X-Conundra-Availability header for Availabilities V2 PUT
  • Add GET endpoint to preview Availabilities for a ShiftSchedule

Version 0.11.0

  • Remove EmployeeAvailabilities PUT
  • Remove X-Conundra-Availability header for Availabilities V2 PUT

Version 0.10.3

  • Add Shift Schedule POST
  • Add Shift Schedule PUT
  • Add Shift Schedule DELETE
  • Add Shift Schedule GET by id
  • Add Shift Schedule GET by employee id

Version 0.10.2

  • Add Shift Schedule POST
  • Add Shift Schedule PUT
  • Add Shift Schedule DELETE
  • Add Shift Schedule GET by id

Version 0.10.1

  • Add Shift Schedule POST
  • Add Shift Schedule PUT
  • Add Shift Schedule DELETE

Version 0.10.0

  • Add Shift Schedule POST
  • Add Shift Schedule PUT

Version 0.9.7

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security
  • Add DELETE for Availability
  • Add PUT for Availability
  • Add GET for Availability
  • Add POST for Availability

Version 0.9.6

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security
  • Add DELETE for Availability
  • Add PUT for Availability
  • Add GET for Availability
  • Add POST for Availabilities

Version 0.9.5

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security
  • Add DELETE for Availability
  • Add PUT for Availability
  • Add GET for Availability

Version 0.9.4

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security
  • Add DELETE for Availability
  • Add PUT for Availability

Version 0.9.3

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security
  • Add DELETE for Availability

Version 0.9.2

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource
  • Remove Fence support from Security

Version 0.9.1

  • Add Availability upsert API v2
  • Add inactive flag to TransportResource

Version 0.9.0

  • Add Availability upsert API v2

Version 0.8.3

  • Modified GeoPoint#resolved:
  • Renamed resolved property to geocoded
  • Added address property, containing the address from the resolving service
  • Add TransportResource PUT-request
  • Add TransportResource GET-request
  • Add TransportResource DELETE-request
  • Add labels to Employee
  • Add labels, reference and custom_data to TransportResource

Version 0.8.2

  • Modified GeoPoint#resolved:
  • Renamed resolved property to geocoded
  • Added address property, containing the address from the resolving service
  • Add TransportResource PUT-request
  • Add TransportResource GET-request
  • Add TransportResource DELETE-request
  • Add labels to Employee

Version 0.8.1

  • Modified GeoPoint#resolved:
  • Renamed resolved property to geocoded
  • Added address property, containing the address from the resolving service
  • Add TransportResource PUT-request
  • Add TransportResource GET-request
  • Add TransportResource DELETE-request

Version 0.8.0

  • Modified GeoPoint#resolved:
  • Renamed resolved property to geocoded
  • Added address property, containing the address from the resolving service
  • Add TransportResource PUT-request
  • Add TransportResource GET-request

Version 0.7.2

  • Add health endpoint
  • Define Employee Pool upsert & get
  • Define Employee upsert & get
  • Add ResolvedInformation to Address
  • Define Employee delete
  • Define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee
  • Update security schemes
  • Add name to Employee#start_location
  • Add endpoint for Employee#availability
  • Add business rules for Employee#availability
  • Add business rules for business IDs

Version 0.7.1

  • Add health endpoint
  • Define Employee Pool upsert & get
  • Define Employee upsert & get
  • Add ResolvedInformation to Address
  • Define Employee delete
  • Define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee
  • Update security schemes
  • Add name to Employee#start_location
  • Add endpoint for Employee#availability
  • Add business rules for Employee#availability

Version 0.7.0

  • Add health endpoint
  • Define Employee Pool upsert & get
  • Define Employee upsert & get
  • Add ResolvedInformation to Address
  • Define Employee delete
  • Define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee
  • Update security schemes
  • Add name to Employee#start_location
  • Add endpoint for Employee#availability

Version 0.6.1

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee
  • Update security schemes
  • Add name to Employee#start_location

Version 0.6.0

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee
  • Update security schemes

Version 0.5.5

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path
  • Add wontDo to Employee

Version 0.5.4

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee
  • Fix base path

Version 0.5.3

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee
  • Add linkedResource to Employee

Version 0.5.2

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties
  • Add skills to Employee

Version 0.5.1

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete
  • Rename Employee properties
  • Rename EmployeePool properties

Version 0.5.0

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete
  • define Employee Pool delete

Version 0.4.0

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address
  • define Employee delete

Version 0.3.1

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get
  • add ResolvedInformation to Address

Version 0.3.0

  • add health endpoint
  • define Employee Pool upsert & get
  • define Employee upsert & get

Version 0.2.0

  • add health endpoint
  • define Employee Pool upsert & get

Version 0.1.0

  • add health endpoint

Domain

API Specification

Company
PTV Logistics
Copyright © Conundra BV - PTV Logistics GmbH. All right reserved.