Conundra Release API (0.1.23)

Download OpenAPI specification:Download

API support: apiteam@conundra.eu URL: https://www.conundra.eu/contact-us License: Terms & conditions Terms of Service

DEPRECATED:

This API is superseded by Planning API v1 and will be removed on 30/06/2025. More information on how to migrate can be found here

Disclaimer: this contract is a Work In Progress and not meant for production integrations. Every aspect is subject to change.

With the release api you get the released routes.

Changelog

Add custom data for proposed execution.

health

Validate connection and accessibility of the Resources API.

Returns a single `pong` string

Very simple endpoint, which can be used for health purpose.

Securitykeycloak

Responses

200

pong

401

Authentication required

get/ping

Request samples

curl
Java

releases

APIs related to Releases of Trips

Retrieve a release with given business id

Returns a release

Securitykeycloak

Request

path Parameters

business-id

required

string

The identifier of a entity instance

Responses

200

404

Not found, this cannot happen when creating an object

get/plannings/{business-id}/releases/latest

Request samples

curl
Java

Response samples

application/json

{"release_metadata": {"planning_business_id": "6411c04114c5cd20fc68cedd",
"released_at": "2021-01-01T10:15:30Z"
},
"trips": [{"id": "4f3abf12-23a2-4039-83db-b6dc7935395d",
"proposed_execution": {"executors": [{"id": "employee-123",
"name": "Patrick Simmons"
}
],
"transport_resources": [{"id": "vehicle-456",
"type": "tractor",
"license_plate": "2-QBD-124"
}
],
"custom_data": {"shop_manager": "John Smith"
}
},
"stops": [{"id": "4f3abf12-23a2-4039-83db-b6dc7935395d",
"location": {"business_id": "locationA",
"name": "locationName",
"type": "CUSTOMER",
"address": {"geo_point": {"latitude": 50.9514048,
"longitude": 3.8067878
},
"address_line": "Voordries 41b",
"city": "Oosterzele",
"zip_code": "9860",
"country_code": "BE"
}
},
"deliveries": [{"order": {"business_id": "orderA",
"description": "a description",
"capacities": [{"type": "weight",
"value": 20.02
}
],
"custom_data": {"shop_manager": "John Smith"
}
},
"timings": {"arrival_at": "2021-01-01T10:30:00Z",
"earliest_arrival_at": "2021-01-01T10:00:00Z",
"latest_arrival_at": "2021-01-01T12:00:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2021-01-01T11:15:00Z"
}
}
],
"pickups": [{"order": {"business_id": "orderA",
"description": "a description",
"capacities": [{"type": "weight",
"value": 20.02
}
],
"custom_data": {"shop_manager": "John Smith"
}
},
"timings": {"arrival_at": "2021-01-01T10:30:00Z",
"earliest_arrival_at": "2021-01-01T10:00:00Z",
"latest_arrival_at": "2021-01-01T12:00:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2021-01-01T11:15:00Z"
}
}
],
"timings": {"arrival_at": "2021-01-01T10:30:00Z",
"earliest_arrival_at": "2021-01-01T10:00:00Z",
"latest_arrival_at": "2021-01-01T12:00:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2021-01-01T11:15:00Z"
}
}
],
"breaks": [{"at": "2021-01-01T11:15:30Z",
"duration": "PT45M"
}
]
}
]
}

Get a list of releases

Returns a list of releases. Most recent first based on moment of release.

Securitykeycloak

Request

query Parameters

released_since

required

string <date-time>

Example: released_since=2021-01-01T10:15:30Z

Responses

200

Releases overview.

get/releases

Request samples

curl
Java

Response samples

application/json

{"releases": [{"release_metadata": {"planning_business_id": "6411c04114c5cd20fc68cedd",
"released_at": "2021-01-01T10:15:30Z"
}
}
]
}