Way Forward Item Repository - API Contract

GET /api/v1/way-forward-items/api/v1/way-forward-items

List all way-forward items

Public

Response Example

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

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

Get a way-forward item by ID

Public

Response Example

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

POST /api/v1/way-forward-items/api/v1/way-forward-items

Create one or more way-forward items for a report

Public

Request Example

{
  "report_id": "rpt_8f3a2c1d",
  "items": [
    {
      "description": "Connect participant Amara D. with job centre referral",
      "assigned_coordinator_id": "usr_coord_011",
      "priority": "high",
      "due_date": "2026-03-27"
    },
    {
      "description": "Arrange language support resources for next session",
      "assigned_coordinator_id": "usr_coord_011",
      "priority": "medium",
      "due_date": "2026-04-03"
    }
  ]
}

Response Example

{
  "created": 2,
  "items": [
    {
      "item_id": "wfi_3a1b9c4d",
      "description": "Connect participant Amara D. with job centre referral",
      "status": "open",
      "created_at": "2026-03-20T14:33:00Z"
    },
    {
      "item_id": "wfi_5e2f0a8b",
      "description": "Arrange language support resources for next session",
      "status": "open",
      "created_at": "2026-03-20T14:33:00Z"
    }
  ]
}

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

Update a way-forward item

Public

Request Example

{
  "status": "resolved",
  "resolution_notes": "Referral sent to Amara on 2026-03-25. Confirmed by coordinator.",
  "resolved_at": "2026-03-25T10:15:00Z"
}

Response Example

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

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

Delete a way-forward item

Public

Response Example

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

GET /api/v1/way-forward-items/api/v1/way-forward-items/by-report/:reportId

Get all way-forward items for a report

Public

Response Example

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

GET /api/v1/way-forward-items/api/v1/way-forward-items/by-coordinator/:coordinatorId

Get all way-forward items assigned to a coordinator

Public

Response Example

{
  "data": [
    {
      "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"
    },
    {
      "item_id": "wfi_7c4d2e1f",
      "report_id": "rpt_1d5e8f3a",
      "description": "Follow up on housing application for participant Lars M.",
      "priority": "medium",
      "status": "in_progress",
      "due_date": "2026-03-28"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 14
  }
}

Additional Metadata

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