API Overview

​

Base URL

https://mantis.peisol.com.ec/api/

http://localhost:8000/api/

​

Architecture

• Django REST Framework - Robust REST API toolkit
• Django 4.2 - Backend framework
• JSON - Response format for all endpoints
• Session-based authentication - Secure authentication using django-user-sessions

​

Available API Modules

​

Projects

• GET /api/projects/resources/available/ - List available resources
• POST /api/projects/resources/add/ - Add resource to project
• POST /api/projects/resources/update/ - Update project resource
• DELETE /api/projects/resources/delete/<id>/ - Remove resource from project
• POST /api/projects/resources/release/ - Release resource from project
• GET /api/projects/<project_id>/resources/ - Get project resources
• GET /api/projects/all-info/<project_id>/ - Get complete project information
• POST /api/projects/<project_id>/close/ - Close a project

​

Equipment

• POST /api/resources/update/ - Update resource information

​

Work Orders

• GET /api/workorders/sheets/project/<project_id>/ - List all sheets for a project
• POST /api/workorders/sheets/create/ - Create new work sheet
• POST /api/workorders/sheets/update/ - Update work sheet
• DELETE /api/workorders/sheets/delete/ - Delete work sheet
• POST /api/workorders/sheets/detail/<detail_id>/days/ - Update sheet detail days
• POST /api/workorders/sheets/reopen/ - Reopen a work sheet
• GET /api/workorders/sheets/items/<sheet_project_id>/ - Get sheet items
• POST /api/workorders/custody_chain/create/ - Create custody chain
• GET /api/workorders/custody_chain/detail/<id>/ - Get custody chain details
• PUT /api/workorders/custody_chain/<id>/edit/ - Edit custody chain
• POST /api/workorders/custody_chain/regenerate-codes/ - Regenerate equipment codes

​

Vehicles

• POST /api/vehicles/cert_vehicle/ - Create/update vehicle certification
• DELETE /api/vehicles/cert_vehicle/<pk>/ - Delete vehicle certification
• POST /api/vehicles/pass_vehicle/ - Create/update vehicle pass
• DELETE /api/vehicles/pass_vehicle/<pk>/ - Delete vehicle pass
• GET /api/vehicles/avaliables/ - List available vehicles

​

Technicals

• POST /api/technicals/create_update_pass_technical/ - Create/update technical pass
• POST /api/technicals/create_update_vaccine/ - Create/update vaccine record
• DELETE /api/technicals/delete_pass_technical/ - Delete technical pass
• DELETE /api/technicals/delete_vaccine/ - Delete vaccine record
• GET /api/technicals/avaliables/ - List available technicals

​

Documents

• POST /api/load_files/ - Upload files
• GET /api/load_files/fields/ - Get model file fields
• GET /api/load_files/tree/ - Get document tree
• GET /api/load_files/project/<project_id>/tree/ - Get project document tree
• POST /api/load_files/project/<project_id>/merge/ - Merge project documents
• POST /api/load_files/project/<project_id>/bulk_custody/ - Bulk custody upload
• GET /api/load_files/sheet/<sheet_id>/merge-generated/ - Merge generated sheet documents
• GET /api/load_files/vehicle/<vehicle_id>/merge-generated/ - Merge generated vehicle documents
• GET /api/load_files/technical/<technical_id>/merge-generated/ - Merge generated technical documents

​

Shipping Guides

• GET /api/shipping/guides/ - List shipping guides
• POST /api/shipping/guides/ - Create shipping guide
• GET /api/shipping/guides/<guide_id>/ - Get shipping guide details
• PUT /api/shipping/guides/<guide_id>/ - Update shipping guide
• DELETE /api/shipping/guides/<pk>/delete/ - Delete shipping guide

​

Maintenance

• GET /api/maintenance/sheets/ - List maintenance sheets
• POST /api/maintenance/sheets/ - Create maintenance sheet
• GET /api/maintenance/sheets/<sheet_id>/ - Get maintenance sheet details
• PUT /api/maintenance/sheets/<sheet_id>/ - Update maintenance sheet
• DELETE /api/maintenance/sheets/<pk>/delete/ - Delete maintenance sheet

​

Calendar

• GET /api/calendar/events/ - List calendar events
• POST /api/calendar/events/ - Create calendar event
• GET /api/calendar/events/<event_id>/ - Get event details
• PUT /api/calendar/events/<event_id>/ - Update event
• POST /api/calendar/events/<event_id>/move/ - Move event
• DELETE /api/calendar/events/<pk>/delete/ - Delete event

​

Response Format

​

Success Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "code": "EQ-001",
      "name": "Equipment Name",
      "type_equipment": "MAQUIN",
      "status_disponibility": "DISPONIBLE",
      "available": true
    }
  ]
}

​

Error Response

{
  "success": false,
  "error": "Error message describing what went wrong",
  "code": "ERROR_CODE"
}

​

HTTP Status Codes

• 200 OK - Request succeeded
• 201 Created - Resource created successfully
• 400 Bad Request - Invalid request parameters
• 401 Unauthorized - Authentication required
• 403 Forbidden - Insufficient permissions
• 404 Not Found - Resource not found
• 500 Internal Server Error - Server error

​

Error Handling

{
  "success": false,
  "error": "Detailed error message",
  "field_errors": {
    "email": ["This field is required"],
    "password": ["Password must be at least 8 characters"]
  }
}

​

CORS Configuration

• CORS_ORIGIN_ALLOW_ALL: Enabled for all origins
• Trusted Origins: Specific domains are whitelisted for CSRF protection
  • https://mantis.peisol.com.ec
  • http://localhost:8000 (development)
  • Additional development and staging origins

​

Rate Limiting

​

Next Steps