Planning API (1.1.0)

Download OpenAPI specification:Download

URL: https://servicedesk.conundra.eu

The planning API provides information about plannings and their lifecycle.

You can find out more in our developer portal.

Changelog

GET /planning/v1/plannings now also shows the planning name and planning labels.
The following endpoints are marked for removal on 30/06/2025. More information on how to migrate can be found here.
- GET /planning/v0/releases
- GET /planning/v0/plannings/{id}/releases/latest

health

Validate connection and accessibility of the API.

Returns a single `pong` string

The ping-endpoint can be used for validating a connection with the application. It will authenticate the caller and returns a pong response when everything is set-up correctly.

Securitykeycloak

Responses

200

Everything set-up correctly

401

Authentication required

get/ping

Response samples

text/plain

pong

plannings

Endpoints used for retrieving information about plannings and its releases.

Get a cursor paged list of plannings

Returns a cursor paged list of plannings. Results are sorted by created_at in descending order. You can find out more about how to use cursors in our developer portal.

Securitykeycloak

Request

query Parameters

released_since	string <date-time> When provided, only plannings which have been released since (exclusive) the given date will be returned. Example: released_since=2021-01-01T10:15:30Z
cursor	string Cursor of the page to retrieve.
limit	integer <int32> [ 1 .. 1000 ] Default: 100 The maximum amount of plannings that should be returned in the response Example: limit=100

Responses

200

400

Bad request

401

Authentication required

get/plannings

Response samples

application/json

{"plannings": [{"id": "86b54c9d-21d7-4b37-af3d-25f03886153b",
"created_at": "2024-11-30T08:15:00Z",
"released_at": "2024-11-30T10:00:00Z",
"name": "Operational Planning",
"labels": ["operational",
"DEMO",
"label-xyz"
]
}
],
"cursor": {"self": "c2VsZl9fcGFnZQ",
"prev": "cHJldmlvdXNfX3BhZ2U",
"next": "bmV4dF9fcGFnZQ"
}
}

Retrieve a released planning using a given planning id

Retrieves detailed information on the given released planning.

Note that information about releases are only stored for 2 weeks after the release was made. If you try to retrieve a release which is older than 2 weeks, you will get a 404 Not Found response.

Securitykeycloak

Request

path Parameters

required

string

The unique identifier of a planning

Responses

200

401

Authentication required

404

Not found

get/plannings/{id}/releases/latest

Response samples

application/json

{"release_metadata": {"planning_id": "86b54c9d-21d7-4b37-af3d-25f03886153b",
"released_at": "2024-11-30T10:00:00Z"
},
"routes": [{"id": "d2c6013e-9194-46ac-a44c-855abf1176ca",
"resource_combination": {"id": "5a4e8c43-80c0-4d5b-8f7e-32ec94f25d79",
"employee": {"business_id": "EMP-18",
"name": "Patrick Simmons",
"custom_data": {"shop_manager": "John Smith"
}
},
"transport_resources": [{"business_id": "TR-14",
"license_plate": "2-QBD-124",
"custom_data": {"shop_manager": "John Smith"
}
}
]
},
"start": {"location": {"business_id": "LOC_001",
"name": "Conundra (Oosterzele)",
"type": "CUSTOMER",
"geo_point": {"latitude": 50.9514048,
"longitude": 3.8067878
},
"address": {"address_line": "Voordries 41b",
"city": "Oosterzele",
"zip_code": "9860",
"country_code": "BE"
}
},
"timings": {"arrival_at": "2024-12-01T10:30:00Z",
"service_time": "PT45M",
"departure_at": "2024-12-01T11:15:00Z"
}
},
"end": {"location": {"business_id": "LOC_001",
"name": "Conundra (Oosterzele)",
"type": "CUSTOMER",
"geo_point": {"latitude": 50.9514048,
"longitude": 3.8067878
},
"address": {"address_line": "Voordries 41b",
"city": "Oosterzele",
"zip_code": "9860",
"country_code": "BE"
}
},
"timings": {"arrival_at": "2024-12-01T10:30:00Z",
"service_time": "PT45M",
"departure_at": "2024-12-01T11:15:00Z"
}
},
"breaks": [{"at": "2024-12-01T11:15:30Z",
"duration": "PT45M"
}
],
"trips": [{"stops": [{"location": {"business_id": "LOC_001",
"name": "Conundra (Oosterzele)",
"type": "CUSTOMER",
"geo_point": {"latitude": 50.9514048,
"longitude": 3.8067878
},
"address": {"address_line": "Voordries 41b",
"city": "Oosterzele",
"zip_code": "9860",
"country_code": "BE"
}
},
"deliveries": [{"order": {"business_id": "O_554",
"description": "Order 554",
"capacities": [{"type": "weight",
"value": 20.02
}
],
"custom_data": {"shop_manager": "John Smith"
}
},
"timings": {"arrival_at": "2024-12-01T10:30:00Z",
"earliest_arrival_at": "2024-12-01T10:00:00Z",
"latest_arrival_at": "2024-12-01T12:00:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2024-12-01T11:15:00Z"
}
}
],
"pickups": [{"order": {"business_id": "O_554",
"description": "Order 554",
"capacities": [{"type": "weight",
"value": 20.02
}
],
"custom_data": {"shop_manager": "John Smith"
}
},
"timings": {"arrival_at": "2024-12-01T10:30:00Z",
"earliest_arrival_at": "2024-12-01T10:00:00Z",
"latest_arrival_at": "2024-12-01T12:00:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2024-12-01T11:15:00Z"
}
}
],
"timings": {"arrival_at": "2024-12-01T10:30:00Z",
"service_time": "PT15M",
"wait_time": "PT30M",
"departure_at": "2024-12-01T11:15:00Z"
}
}
]
}
]
}
]
}