REST API Guide

High school timetable solver integration via cURL

1. Download demo data

            Copy
            curl -X GET -H 'Accept:application/json' http://localhost:8080/demo-data/SMALL -o sample.json
    

2. Post the sample data for solving

The POST operation returns a jobId that should be used in subsequent commands.

            Copy
            curl -X POST -H 'Content-Type:application/json' http://localhost:8080/timetables -d@sample.json
    

3. Get the current status and score

            Copy
            curl -X GET -H 'Accept:application/json' http://localhost:8080/timetables/{jobId}/status
    

4. Get the complete solution

            Copy
            curl -X GET -H 'Accept:application/json' http://localhost:8080/timetables/{jobId}
    

5. Terminate solving early

            Copy
            curl -X DELETE -H 'Accept:application/json' http://localhost:8080/timetables/{id}