Skip to content

Management Endpoint Documentation

Tareq Kirresh edited this page May 7, 2018 · 3 revisions

Management Endpoints

Authentication

POST /user/auth --> Authenticate a User.

Notification

GET /notifications/{token} --> Subscribe to notifications.

Driver Management

GET /user/driver/manager/ --> List all drivers with passwords.

GET /user/driver/manager/{driver_id} --> Read a particular driver

POST /user/driver/manager/ --> Create a new driver with a random username and password.

PUT /user/driver/manager/{driver_id} --> Edit a driver.

DELETE /user/driver/manager/{driver_id} --> Delete a driver.

API User Management

GET /user/api/management/ --> List all API users with tokens.

GET /user/api/management/{api_user_id} --> Read a particular API user.

POST /user/api/management/ --> Create a new API user with a random token.

PUT /user/api/management/{api_user_id} --> Edit an API user.

DELETE /user/api/management/{api_user_id} --> Delete an API user.

Dispatcher Management

GET /user/dispatcher/manager/ --> List all Dispatchers with passwords.

GET /user/dispatcher/manager/{dispatcher_id} --> Read a particular dispatcher.

POST /user/dispatcher/manager/ --> Create a new dispatcher.

PUT /user/dispatcher/manager/{dispatcher_id} --> Update a dispatcher.

DELETE /user/dispatcher/manager/{dispatcher_id} --> Delete a dispatcher.

Vehicle Management

GET /vehicle/manage/ --> List all vehicles.

GET /vehicle/manage/{vehicle_id} --> Read a vehicle.

POST /vehicle/manage/ --> Create a new vehicle, location entry, and status entry.

PUT /vehicle/manage/{vehicle_id} --> Update a vehicle.

DELETE /vehicle/manage/{vehicle_id} --> Delete a vehicle, its status entry, and its location entry.

Geographical Area Management

GET /geographicalarea/manager/ --> List all geographical areas(binary data).

GET /geographicalarea/manager/{area_id} --> Read the geographical area coordinates(string).

POST /geographicalarea/manager/ --> create a new geographical area.

DELETE /geographicalarea/manager/{area_id} --> Delete a geographical area.

Jurisdiction Management

GET /user/dispatcher/manager/jurisdiction/ --> List all jurisdiction relationships for all dispatchers.

GET /user/dispatcher/manager/jurisdiction/{dispatcher_id} --> List the jurisdictions of a dispatcher.

PUT /user/dispatcher/manager/jurisdiction/{dispatcher_id} --> add or remove jurisdictions to a dispatcher.

DELETE /user/dispatcher/manager/jurisdiction/{dispatcher_id} --> delete all dispatcher jurisdictions.