SwarmLogistics

General notes

The PlanSim server generates tour plans for given vehicles and freight orders.

API detail

Auth

create Authentication Token

curl -X POST -H "Content-Type: application/json" -d '{
    "email": "user1@swarm.com",
    "password": "default",
    "secret": "VHy43Rd7ta3uAbwX3L8S5q7ROBcKfwPwSPe53c7TR-1vm2MTczYD7TWzwIHyutUW-A4KGPqe7PQMTdqn6uZC7A"
}' "{{baseUrl}}/api/authenticate"
POST %7B%7BbaseUrl%7D%7D/api/authenticate HTTP/1.1
Host: 
Content-Type: application/json

{
    "email": "user1@swarm.com",
    "password": "default",
    "secret": "VHy43Rd7ta3uAbwX3L8S5q7ROBcKfwPwSPe53c7TR-1vm2MTczYD7TWzwIHyutUW-A4KGPqe7PQMTdqn6uZC7A"
}
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Type*/*

Truck


Get trucks

curl -X GET "{{baseUrl}}/truck"
GET %7B%7BbaseUrl%7D%7D/truck HTTP/1.1
Host: 
Status200 OK
Content-Typeapplication/json
Transfer-Encodingchunked
DateWed, 17 Feb 2021 20:12:20 GMT
Keep-Alivetimeout=60
Connectionkeep-alive
[
    {
        "id": "truckA",
        "description": "descriptionA",
        "idAddressHome": "addressHomeIdA",
        "capacityWeight": 0,
        "capacitySpace": 0,
        "overrideCPH": 0,
        "overrideCPHEnabled": false,
        "overrideCPKm": 0,
        "overrideCPKmEnabled": false,
        "overrideFixCosts": 0,
        "overrideFixCostsEnabled": false,
        "overrideRoadChargePKm": 0,
        "overrideRoadChargePKmEnabled": false,
        "emissionClass": 0,
        "axisCont": 0
    },
    {
        "id": "truckB",
        "description": "descriptionA",
        "idAddressHome": "addressHomeIdA",
        "capacityWeight": 0,
        "capacitySpace": 0,
        "overrideCPH": 0,
        "overrideCPHEnabled": false,
        "overrideCPKm": 0,
        "overrideCPKmEnabled": false,
        "overrideFixCosts": 0,
        "overrideFixCostsEnabled": false,
        "overrideRoadChargePKm": 0,
        "overrideRoadChargePKmEnabled": false,
        "emissionClass": 0,
        "axisCont": 0
    }
]
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get truck by its id

curl -X GET "{{baseUrl}}/truck/{{truckId}}"
GET %7B%7BbaseUrl%7D%7D/truck/%7B%7BtruckId%7D%7D HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typeapplication/json
Transfer-Encodingchunked
DateWed, 17 Feb 2021 20:13:52 GMT
Keep-Alivetimeout=60
Connectionkeep-alive
{
    "id": "truckA",
    "description": "descriptionA",
    "idAddressHome": "addressHomeIdA",
    "capacityWeight": 0,
    "capacitySpace": 0,
    "overrideCPH": 0,
    "overrideCPHEnabled": false,
    "overrideCPKm": 0,
    "overrideCPKmEnabled": false,
    "overrideFixCosts": 0,
    "overrideFixCostsEnabled": false,
    "overrideRoadChargePKm": 0,
    "overrideRoadChargePKmEnabled": false,
    "emissionClass": 0,
    "axisCont": 0
}
Status200 OK
Content-Type*/*

Update truck

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "{{truckId}}",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": 2.00,
    "capacitySpace": 2.00,
    "overrideCPH": 2.00,
    "overrideCPHEnabled": true,
    "overrideCPKm": 1.00,
    "overrideCPKmEnabled": true,
    "overrideFixCosts": 1.00,
    "overrideFixCostsEnabled": true,
    "overrideRoadChargePKm": 1.00,
    "overrideRoadChargePKmEnabled": true,
    "emissionClass": 2,
    "axisCont": 2
}' "{{baseUrl}}/truck"
PUT %7B%7BbaseUrl%7D%7D/truck HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "{{truckId}}",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": 2.00,
    "capacitySpace": 2.00,
    "overrideCPH": 2.00,
    "overrideCPHEnabled": true,
    "overrideCPKm": 1.00,
    "overrideCPKmEnabled": true,
    "overrideFixCosts": 1.00,
    "overrideFixCostsEnabled": true,
    "overrideRoadChargePKm": 1.00,
    "overrideRoadChargePKmEnabled": true,
    "emissionClass": 2,
    "axisCont": 2
}
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status200 OK
Content-Type*/*

Create truck

curl -X POST -H "Content-Type: application/json" -d '{
    "description": "",
    "idAddressHome": "",
    "capacityWeight": 1.00,
    "capacitySpace": 1.00,
    "overrideCPH": 1.00,
    "overrideCPHEnabled": true,
    "overrideCPKm": 1.00,
    "overrideCPKmEnabled": true,
    "overrideFixCosts": 1.00,
    "overrideFixCostsEnabled": true,
    "overrideRoadChargePKm": 1.00,
    "overrideRoadChargePKmEnabled": true,
    "emissionClass": 2,
    "axisCont": 2
}' "{{baseUrl}}/truck"
POST %7B%7BbaseUrl%7D%7D/truck HTTP/1.1
Host: 
Content-Type: application/json

{
    "description": "",
    "idAddressHome": "",
    "capacityWeight": 1.00,
    "capacitySpace": 1.00,
    "overrideCPH": 1.00,
    "overrideCPHEnabled": true,
    "overrideCPKm": 1.00,
    "overrideCPKmEnabled": true,
    "overrideFixCosts": 1.00,
    "overrideFixCostsEnabled": true,
    "overrideRoadChargePKm": 1.00,
    "overrideRoadChargePKmEnabled": true,
    "emissionClass": 2,
    "axisCont": 2
}
Status404 Not Found
Content-Typetext/plain
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete truck

curl -X DELETE "{{baseUrl}}/truck/{{deletionTruckId}}"
DELETE %7B%7BbaseUrl%7D%7D/truck/%7B%7BdeletionTruckId%7D%7D HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Transport


Get transports

curl -X GET "{{baseUrl}}/transport"
GET %7B%7BbaseUrl%7D%7D/transport HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get transport by its id

curl -X GET "{{baseUrl}}/transport/{{transportId}}"
GET %7B%7BbaseUrl%7D%7D/transport/%7B%7BtransportId%7D%7D HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Update transport

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "idDriver": "",
    "idVehicle": "",
    "idTrailer": "",
    "handlingDurationModifier": ""
}' "{{baseUrl}}/transport"
PUT %7B%7BbaseUrl%7D%7D/transport HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "idDriver": "",
    "idVehicle": "",
    "idTrailer": "",
    "handlingDurationModifier": ""
}
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Create transport

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "idDriver": "",
    "idVehicle": "",
    "idTrailer": "",
    "handlingDurationModifier": ""
}' "{{baseUrl}}/transport"
POST %7B%7BbaseUrl%7D%7D/transport HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "idDriver": "",
    "idVehicle": "",
    "idTrailer": "",
    "handlingDurationModifier": ""
}
Status201 Created
Content-Type*/*
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete transport

curl -X DELETE "{{baseUrl}}/transport/:transportId"
DELETE %7B%7BbaseUrl%7D%7D/transport/:transportId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Trailer


Get trailers

curl -X GET "{{baseUrl}}/trailer"
GET %7B%7BbaseUrl%7D%7D/trailer HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get trailer by its id

curl -X GET "{{baseUrl}}/trailer/:trailerId"
GET %7B%7BbaseUrl%7D%7D/trailer/:trailerId HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Update trailer

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": "",
    "axisCount": ""
}' "{{baseUrl}}/trailer"
PUT %7B%7BbaseUrl%7D%7D/trailer HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": "",
    "axisCount": ""
}
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Create trailer

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": "",
    "axisCount": ""
}' "{{baseUrl}}/trailer"
POST %7B%7BbaseUrl%7D%7D/trailer HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": "",
    "axisCount": ""
}
Status201 Created
Content-Type*/*
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete trailer

curl -X DELETE "{{baseUrl}}/trailer/:trailerId"
DELETE %7B%7BbaseUrl%7D%7D/trailer/:trailerId HTTP/1.1
Host: 
Status200 OK
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Freight order


Get freight orders

curl -X GET "{{baseUrl}}/fo"
GET %7B%7BbaseUrl%7D%7D/fo HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get freight order by its id

curl -X GET "{{baseUrl}}/fo/:foId"
GET %7B%7BbaseUrl%7D%7D/fo/:foId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Update freight order

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "customId": "",
    "weight": "",
    "space": "",
    "idAddressPickup": "",
    "addressPickup": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "idAddressDispatch": "",
    "addressDispatch": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "twPickup": [
        "",
        ""
    ],
    "twDispatch": [
        "",
        ""
    ],
    "handlingDurationPickup": "",
    "handlingDurationDispatch": ""
}' "{{baseUrl}}/fo"
PUT %7B%7BbaseUrl%7D%7D/fo HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "customId": "",
    "weight": "",
    "space": "",
    "idAddressPickup": "",
    "addressPickup": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "idAddressDispatch": "",
    "addressDispatch": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "twPickup": [
        "",
        ""
    ],
    "twDispatch": [
        "",
        ""
    ],
    "handlingDurationPickup": "",
    "handlingDurationDispatch": ""
}
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Create freight order

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "customId": "",
    "weight": "",
    "space": "",
    "idAddressPickup": "",
    "addressPickup": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "idAddressDispatch": "",
    "addressDispatch": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "twPickup": [
        "",
        ""
    ],
    "twDispatch": [
        "",
        ""
    ],
    "handlingDurationPickup": "",
    "handlingDurationDispatch": ""
}' "{{baseUrl}}/fo"
POST %7B%7BbaseUrl%7D%7D/fo HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "customId": "",
    "weight": "",
    "space": "",
    "idAddressPickup": "",
    "addressPickup": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "idAddressDispatch": "",
    "addressDispatch": {
        "id": "",
        "contract": "",
        "streetName": "",
        "streetNo": "",
        "addInfo": "",
        "zip": "",
        "city": "",
        "location": {
            "lon": "",
            "lat": ""
        }
    },
    "twPickup": [
        "",
        ""
    ],
    "twDispatch": [
        "",
        ""
    ],
    "handlingDurationPickup": "",
    "handlingDurationDispatch": ""
}
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Delete freight order

curl -X DELETE "{{baseUrl}}/fo/:foId"
DELETE %7B%7BbaseUrl%7D%7D/fo/:foId HTTP/1.1
Host: 
Status200 OK
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Execution


Get executions

curl -X GET "{{baseUrl}}/execution"
GET %7B%7BbaseUrl%7D%7D/execution HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get execution by its id

curl -X GET "{{baseUrl}}/execution/:executionId"
GET %7B%7BbaseUrl%7D%7D/execution/:executionId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Update execution

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "idResult": "",
    "state": ""
}' "{{baseUrl}}/execution"
PUT %7B%7BbaseUrl%7D%7D/execution HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "idResult": "",
    "state": ""
}
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Create execution

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "idResult": "",
    "state": ""
}' "{{baseUrl}}/execution"
POST %7B%7BbaseUrl%7D%7D/execution HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "idResult": "",
    "state": ""
}
Status404 Not Found
Content-Typetext/plain
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete execution

curl -X DELETE "{{baseUrl}}/execution/:executionId"
DELETE %7B%7BbaseUrl%7D%7D/execution/:executionId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Driver


Get drivers

curl -X GET "{{baseUrl}}/driver"
GET %7B%7BbaseUrl%7D%7D/driver HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Get driver by its id

curl -X GET "{{baseUrl}}/driver/:driverId"
GET %7B%7BbaseUrl%7D%7D/driver/:driverId HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Update driver

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "costPerHour": "",
    "pauseDurationMinutes": "",
    "pauseAfterWorkedMinutes": "",
    "workDurationMaxMinutes": ""
}' "{{baseUrl}}/driver"
PUT %7B%7BbaseUrl%7D%7D/driver HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "costPerHour": "",
    "pauseDurationMinutes": "",
    "pauseAfterWorkedMinutes": "",
    "workDurationMaxMinutes": ""
}
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status200 OK
Content-Type*/*

Create driver

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "costPerHour": "",
    "pauseDurationMinutes": "",
    "pauseAfterWorkedMinutes": "",
    "workDurationMaxMinutes": ""
}' "{{baseUrl}}/driver"
POST %7B%7BbaseUrl%7D%7D/driver HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "costPerHour": "",
    "pauseDurationMinutes": "",
    "pauseAfterWorkedMinutes": "",
    "workDurationMaxMinutes": ""
}
Status404 Not Found
Content-Typetext/plain
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete driver

curl -X DELETE "{{baseUrl}}/driver/:driverId"
DELETE %7B%7BbaseUrl%7D%7D/driver/:driverId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Car


Get cars

curl -X GET "{{baseUrl}}/car"
GET %7B%7BbaseUrl%7D%7D/car HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Get car by its id

curl -X GET "{{baseUrl}}/car/:carId"
GET %7B%7BbaseUrl%7D%7D/car/:carId HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Update car

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": ""
}' "{{baseUrl}}/car"
PUT %7B%7BbaseUrl%7D%7D/car HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": ""
}
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Create car

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": ""
}' "{{baseUrl}}/car"
POST %7B%7BbaseUrl%7D%7D/car HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "idAddressHome": "",
    "capacityWeight": "",
    "capacitySpace": "",
    "overrideCPH": "",
    "overrideCPHEnabled": "",
    "overrideCPKm": "",
    "overrideCPKmEnabled": "",
    "overrideFixCosts": "",
    "overrideFixCostsEnabled": ""
}
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Delete car

curl -X DELETE "{{baseUrl}}/car/:carId"
DELETE %7B%7BbaseUrl%7D%7D/car/:carId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Address


Get addresses

curl -X GET "{{baseUrl}}/address"
GET %7B%7BbaseUrl%7D%7D/address HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Get address by its id

curl -X GET "{{baseUrl}}/address/:addressId"
GET %7B%7BbaseUrl%7D%7D/address/:addressId HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Update address

curl -X PUT -H "Content-Type: application/json" -d '{
    "id": "",
    "contract": "",
    "streetName": "",
    "streetNo": "",
    "addInfo": "",
    "zip": "",
    "city": "",
    "location": {
        "lon": "",
        "lat": ""
    }
}' "{{baseUrl}}/address"
PUT %7B%7BbaseUrl%7D%7D/address HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "contract": "",
    "streetName": "",
    "streetNo": "",
    "addInfo": "",
    "zip": "",
    "city": "",
    "location": {
        "lon": "",
        "lat": ""
    }
}
Status200 OK
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Create address

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "contract": "",
    "streetName": "",
    "streetNo": "",
    "addInfo": "",
    "zip": "",
    "city": "",
    "location": {
        "lon": "",
        "lat": ""
    }
}' "{{baseUrl}}/address"
POST %7B%7BbaseUrl%7D%7D/address HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "contract": "",
    "streetName": "",
    "streetNo": "",
    "addInfo": "",
    "zip": "",
    "city": "",
    "location": {
        "lon": "",
        "lat": ""
    }
}
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status201 Created
Content-Type*/*

Delete address by id

curl -X DELETE "{{baseUrl}}/address/:addressId"
DELETE %7B%7BbaseUrl%7D%7D/address/:addressId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Task


Get tasks

curl -X GET "{{baseUrl}}/task"
GET %7B%7BbaseUrl%7D%7D/task HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get task by its id

curl -X GET "{{baseUrl}}/task/:taskId"
GET %7B%7BbaseUrl%7D%7D/task/:taskId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Create task

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "description": "",
    "transport": [
        "",
        ""
    ],
    "fos": [
        "",
        ""
    ],
    "empStopsPerTransport": ""
}' "{{baseUrl}}/task"
POST %7B%7BbaseUrl%7D%7D/task HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "description": "",
    "transport": [
        "",
        ""
    ],
    "fos": [
        "",
        ""
    ],
    "empStopsPerTransport": ""
}
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Delete task

curl -X DELETE "{{baseUrl}}/task/:taskId"
DELETE %7B%7BbaseUrl%7D%7D/task/:taskId HTTP/1.1
Host: 
Status200 OK
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Execution State


Get execution states

curl -X GET "{{baseUrl}}/executionState?idExecution=minim dolore Ut&idTransport=minim dolore Ut"
GET %7B%7BbaseUrl%7D%7D/executionState?idExecution=minim dolore Ut&idTransport=minim dolore Ut HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get execution state by its id

curl -X GET "{{baseUrl}}/executionState/:executionStateId"
GET %7B%7BbaseUrl%7D%7D/executionState/:executionStateId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Create execution state

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "idExecution": "",
    "idTransport": "",
    "location": {
        "lon": "",
        "lat": ""
    },
    "timestamp": "",
    "events": [
        {
            "location": {
                "lon": "",
                "lat": ""
            },
            "timestamp": "",
            "event": {
                "action": "",
                "detail": "",
                "idFO": ""
            }
        },
        {
            "location": {
                "lon": "",
                "lat": ""
            },
            "timestamp": "",
            "event": {
                "action": "",
                "detail": "",
                "idFO": ""
            }
        }
    ]
}' "{{baseUrl}}/executionState"
POST %7B%7BbaseUrl%7D%7D/executionState HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "idExecution": "",
    "idTransport": "",
    "location": {
        "lon": "",
        "lat": ""
    },
    "timestamp": "",
    "events": [
        {
            "location": {
                "lon": "",
                "lat": ""
            },
            "timestamp": "",
            "event": {
                "action": "",
                "detail": "",
                "idFO": ""
            }
        },
        {
            "location": {
                "lon": "",
                "lat": ""
            },
            "timestamp": "",
            "event": {
                "action": "",
                "detail": "",
                "idFO": ""
            }
        }
    ]
}
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status201 Created
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Delete execution state

curl -X DELETE "{{baseUrl}}/executionState/:executionStateId"
DELETE %7B%7BbaseUrl%7D%7D/executionState/:executionStateId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Calculation


Get calculations

curl -X GET "{{baseUrl}}/calculation"
GET %7B%7BbaseUrl%7D%7D/calculation HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Get calculation by its id

curl -X GET "{{baseUrl}}/calculation/:calculationId"
GET %7B%7BbaseUrl%7D%7D/calculation/:calculationId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Create calculation

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "idTask": "",
    "metric": "",
    "state": "",
    "idResult": ""
}' "{{baseUrl}}/calculation"
POST %7B%7BbaseUrl%7D%7D/calculation HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "idTask": "",
    "metric": "",
    "state": "",
    "idResult": ""
}
Status201 Created
Content-Type*/*
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain
Status404 Not Found
Content-Typetext/plain

Delete calculation

curl -X DELETE "{{baseUrl}}/calculation/:calculationId"
DELETE %7B%7BbaseUrl%7D%7D/calculation/:calculationId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Beacon


Get beacons

curl -X GET "{{baseUrl}}/beacon?idExecution=minim dolore Ut&idTransport=minim dolore Ut"
GET %7B%7BbaseUrl%7D%7D/beacon?idExecution=minim dolore Ut&idTransport=minim dolore Ut HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Get beacon by its id

curl -X GET "{{baseUrl}}/beacon/:beaconId"
GET %7B%7BbaseUrl%7D%7D/beacon/:beaconId HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Create beacon

curl -X POST -H "Content-Type: application/json" -d '{
    "id": "",
    "idExecution": "",
    "idTransport": "",
    "location": {
        "lon": "",
        "lat": ""
    },
    "timestamp": "",
    "eventType": "",
    "payload": ""
}' "{{baseUrl}}/beacon"
                                
                                
POST %7B%7BbaseUrl%7D%7D/beacon HTTP/1.1
Host: 
Content-Type: application/json

{
    "id": "",
    "idExecution": "",
    "idTransport": "",
    "location": {
        "lon": "",
        "lat": ""
    },
    "timestamp": "",
    "eventType": "",
    "payload": ""
}
                                
                            
                        

                        
                        
Status201 Created
Content-Type*/*
Status404 Not Found
Content-Typetext/plain
Status422 Unprocessable Entity (WebDAV) (RFC 4918)
Content-Typetext/plain

Delete beacon

curl -X DELETE "{{baseUrl}}/beacon/:beaconId"
DELETE %7B%7BbaseUrl%7D%7D/beacon/:beaconId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Result


Get results

curl -X GET "{{baseUrl}}/result"
GET %7B%7BbaseUrl%7D%7D/result HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain

Get Result by its id

curl -X GET "{{baseUrl}}/result/:resultId"
GET %7B%7BbaseUrl%7D%7D/result/:resultId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Type*/*

Delete results

curl -X DELETE "{{baseUrl}}/result/:resultId"
DELETE %7B%7BbaseUrl%7D%7D/result/:resultId HTTP/1.1
Host: 
Status404 Not Found
Content-Typetext/plain
Status200 OK
Content-Typetext/plain

Conflicts


Get conflicts

curl -X GET "{{baseUrl}}/conflicts?idTransport=minim dolore Ut"
GET %7B%7BbaseUrl%7D%7D/conflicts?idTransport=minim dolore Ut HTTP/1.1
Host: 
Status200 OK
Content-Type*/*
Status404 Not Found
Content-Typetext/plain