M2 API Reference

The M2 Maintenance API provides endpoints for work orders, assets, vendors, and emergency management.

Base URL

Production: https://m2.inspiringlivingsolutions.com/api
Development: http://localhost:3000/api

Authentication

Requires Authentik SSO session via NextAuth.

Endpoints

Work Orders

List Work Orders

GET /work-orders

Query Parameters:

Parameter	Type	Description
page	number	Page number
limit	number	Items per page
status	string	Filter by status
priority	string	Filter by priority
villaId	string	Filter by property
assigneeId	string	Filter by assignee

Response:

{
  "data": [
    {
      "id": "uuid",
      "title": "AC not cooling",
      "status": "IN_PROGRESS",
      "priority": "HIGH",
      "category": "HVAC",
      "villa": { "id": "uuid", "name": "Villa Sunrise" },
      "assignee": { "id": "uuid", "name": "John Tech" },
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ],
  "pagination": { "page": 1, "limit": 10, "total": 150 }
}

Get Work Order

GET /work-orders/:id

Create Work Order

POST /work-orders

Body:

{
  "title": "AC not cooling",
  "description": "Master bedroom AC not working",
  "villaId": "uuid",
  "category": "HVAC",
  "priority": "HIGH",
  "assetId": "uuid"
}

Update Work Order

PATCH /work-orders/:id

Assign Work Order

POST /work-orders/:id/assign

Body:

{
  "assigneeId": "uuid",
  "assigneeType": "TECHNICIAN",
  "dueDate": "2024-01-20T17:00:00Z"
}

Add Comment

POST /work-orders/:id/comments

Body:

{
  "content": "Parts ordered, arriving tomorrow",
  "type": "PUBLIC"
}

---

Assets

List Assets

GET /assets

Get Asset

GET /assets/:id

Create Asset

POST /assets

Body:

{
  "name": "Samsung AC Unit",
  "category": "HVAC",
  "villaId": "uuid",
  "brand": "Samsung",
  "model": "AR24TXHQ",
  "serialNumber": "SN12345",
  "purchaseDate": "2023-01-15",
  "warrantyEndDate": "2026-01-15"
}

Update Health Score

PATCH /assets/:id/health

Body:

{
  "healthScore": 75,
  "condition": "GOOD",
  "notes": "Minor wear observed"
}

---

Vendors

List Vendors

GET /vendors

Get Vendor

GET /vendors/:id

Create Vendor

POST /vendors

Body:

{
  "companyName": "AC Service Co",
  "contactName": "Somchai",
  "email": "[email protected]",
  "phone": "+66812345678",
  "categories": ["HVAC", "ELECTRICAL"]
}

Rate Vendor

POST /vendors/:id/ratings

Body:

{
  "workOrderId": "uuid",
  "quality": 5,
  "timeliness": 4,
  "communication": 5,
  "value": 4,
  "comments": "Excellent service"
}

---

Emergency Incidents

Report Emergency

POST /emergencies

Body:

{
  "villaId": "uuid",
  "category": "WATER",
  "severity": "CRITICAL",
  "description": "Major water leak in kitchen",
  "location": "Kitchen"
}

Update Status

PATCH /emergencies/:id/status

Body:

{
  "status": "CONTAINED",
  "notes": "Water shut off, waiting for plumber"
}

Log Action

POST /emergencies/:id/actions

Body:

{
  "action": "Shut off main water valve",
  "performedBy": "uuid"
}

---

PMP (Preventive Maintenance)

List Templates

GET /pmp/templates

Create Schedule

POST /pmp/schedules

Body:

{
  "templateId": "uuid",
  "assetId": "uuid",
  "frequency": "MONTHLY",
  "startDate": "2024-01-01",
  "assigneeId": "uuid"
}

---

Field Notes

Create Field Note

POST /field-notes

Body (multipart/form-data):

• content: Note text
• type: TEXT | VOICE | PHOTO
• workOrderId: Linked work order (optional)
• assetId: Linked asset (optional)
• file: Media file (for VOICE/PHOTO)

---

Timesheets

Log Time

POST /timesheets

Body:

{
  "workOrderId": "uuid",
  "hours": 2.5,
  "activityType": "REPAIR",
  "date": "2024-01-15",
  "notes": "Replaced compressor"
}

---

Error Responses

{
  "error": {
    "code": "WORK_ORDER_NOT_FOUND",
    "message": "Work order not found",
    "statusCode": 404
  }
}