Endpoints
==========================================================
*Tarot Routing - Route Optimisation API*

Synchronous Route Optimisation API
----------------------------------

.. http:post:: /api/optimise

   A synchronous endpoint for all Route Optimisation requests

   :reqheader Authorization: The word "Token" followed by a space, followed by your Tarot Routing Token. Don't have one? Contact us info@tarotanalytics.com
   :reqheader Content-Type: application/json
   :reqjson jobs: A list of :py:data:`Jobs <Job>` to be considered in the optimisation
   :reqjson drivers: A list of :py:data:`Drivers <Driver>` available to serve those :py:data:`Jobs <Job>`
   :reqjson settings: The :py:data:`Settings` which govern this optimisation
   :resjson runs: A list of optimised runs. The first item in each Run is the :py:data:`Driver`. Subsequent items (if any) are the :py:data:`Jobs <Job>`
   :resjson unserved_jobs: A list jobs which the optimiser could not plan given the constraints and available :py:data:`Drivers <Driver>`
   :statuscode 200: Optimised Successfully
   :statuscode 400: There was an issue with your request, please look at the message for details.


   **Example request**:

   .. literalinclude:: _static/ex1.json
      :language: json
      :caption: Request Body ``ex1.json``

   .. tabs::
      .. tab:: bash
         .. literalinclude:: _static/optimise_req.sh
            :language: bash
      
      .. tab:: python
         .. literalinclude:: _static/optimise_req.py
            :language: python
   

   **Example response**:



   .. sourcecode:: http

      HTTP/1.1 200 OK

   .. literalinclude:: _static/resp1.json
      :language: json
      :caption: Response Body


Asynchronous Route Optimisation API
-----------------------------------

Coming soon.

Interested? Let us know info@tarotanalytics.com