Way Forward Task Service - API Contract

GET /api/v1/way-forward-tasks/api/v1/way-forward-tasks

List all way-forward task entries

Public

Response Example

{
  "data": [
    {
      "item_id": "wfi_3a1b9c4d",
      "report_id": "rpt_8f3a2c1d",
      "description": "Connect participant Amara D. with job centre referral",
      "assigned_coordinator_id": "usr_coord_011",
      "status": "open",
      "priority": "high",
      "due_date": "2026-03-27"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 14
  }
}

GET /api/v1/way-forward-tasks/api/v1/way-forward-tasks/:id

Get a specific way-forward task

Public

Response Example

{
  "item_id": "wfi_3a1b9c4d",
  "report_id": "rpt_8f3a2c1d",
  "description": "Connect participant Amara D. with job centre referral",
  "assigned_coordinator_id": "usr_coord_011",
  "status": "open",
  "priority": "high",
  "due_date": "2026-03-27",
  "created_at": "2026-03-20T14:33:00Z"
}

POST /api/v1/way-forward-tasks/api/v1/way-forward-tasks

Create follow-up tasks from a way-forward entry list

Public

Request Example

{
  "report_id": "rpt_8f3a2c1d",
  "way_forward_entries": [
    {
      "description": "Connect participant Amara D. with job centre referral",
      "assigned_coordinator_id": "usr_coord_011",
      "priority": "high",
      "due_date": "2026-03-27"
    },
    {
      "description": "Book interpreter for next session on 2026-04-03",
      "assigned_coordinator_id": "usr_coord_011",
      "priority": "medium",
      "due_date": "2026-04-01"
    }
  ]
}

Response Example

{
  "report_id": "rpt_8f3a2c1d",
  "created": 2,
  "items": [
    {
      "item_id": "wfi_3a1b9c4d",
      "status": "open",
      "created_at": "2026-03-20T14:33:00Z"
    },
    {
      "item_id": "wfi_6b2c0d9e",
      "status": "open",
      "created_at": "2026-03-20T14:33:00Z"
    }
  ]
}

PUT /api/v1/way-forward-tasks/api/v1/way-forward-tasks/:id

Update a way-forward task (description, assignment, due date)

Public

Request Example

{
  "assigned_coordinator_id": "usr_coord_014",
  "due_date": "2026-03-28",
  "priority": "urgent"
}

Response Example

{
  "item_id": "wfi_3a1b9c4d",
  "assigned_coordinator_id": "usr_coord_014",
  "due_date": "2026-03-28",
  "updated_at": "2026-03-26T11:00:00Z"
}

DELETE /api/v1/way-forward-tasks/api/v1/way-forward-tasks/:id

Delete a way-forward task

Public

Response Example

{
  "deleted": true,
  "item_id": "wfi_3a1b9c4d"
}

POST /api/v1/way-forward-tasks/api/v1/way-forward-tasks/:id/resolve

Mark a way-forward task as resolved

Public

Request Example

{
  "resolution_notes": "Referral sent to Amara on 2026-03-25. Case worker confirmed receipt.",
  "resolved_by": "usr_coord_011"
}

Response Example

{
  "item_id": "wfi_3a1b9c4d",
  "status": "resolved",
  "resolved_by": "usr_coord_011",
  "resolved_at": "2026-03-25T10:15:00Z"
}

GET /api/v1/way-forward-tasks/api/v1/way-forward-tasks/coordinator-queue/:coordinatorId

Get the open task queue for a coordinator, sorted by priority

Public

Response Example

{
  "coordinator_id": "usr_coord_011",
  "queue_summary": {
    "open": 8,
    "in_progress": 3,
    "overdue": 2
  },
  "data": [
    {
      "item_id": "wfi_7c4d2e1f",
      "report_id": "rpt_1d5e8f3a",
      "description": "Follow up on housing application for participant Lars M.",
      "priority": "urgent",
      "status": "open",
      "due_date": "2026-03-24",
      "overdue": true
    },
    {
      "item_id": "wfi_3a1b9c4d",
      "report_id": "rpt_8f3a2c1d",
      "description": "Connect participant Amara D. with job centre referral",
      "priority": "high",
      "status": "open",
      "due_date": "2026-03-27",
      "overdue": false
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 11
  }
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}