Pause Management Service - API Contract

POST /api/v1/pause-management/api/v1/pause-management/:mentorId/activate

Activate a pause for a mentor

Public

Request Example

{
  "expected_return_date": "2026-05-01T00:00:00Z",
  "reason": "personal_leave",
  "initiated_by": "coordinator-007"
}

Response Example

{
  "mentor_id": "mentor-042",
  "status": "paused",
  "pause_activated_at": "2026-03-26T08:30:00Z",
  "expected_return_date": "2026-05-01T00:00:00Z",
  "pause_record_id": "pause-rec-0019",
  "website_hidden": true,
  "notifications_sent": [
    "coordinator",
    "mentor"
  ]
}

POST /api/v1/pause-management/api/v1/pause-management/:mentorId/lift

Lift an active pause and restore the mentor

Public

Request Example

{
  "lifted_by": "coordinator-007",
  "notes": "Mentor confirmed return"
}

Response Example

{
  "mentor_id": "mentor-042",
  "status": "active",
  "pause_lifted_at": "2026-04-15T09:00:00Z",
  "pause_record_id": "pause-rec-0019",
  "website_restored": true,
  "notifications_sent": [
    "coordinator",
    "mentor"
  ]
}

POST /api/v1/pause-management/api/v1/pause-management/:mentorId/auto-expire

Trigger automatic pause due to certification expiry

Public

Request Example

{
  "triggered_by": "certification-expiry-checker",
  "expiry_date": "2026-03-31T00:00:00Z"
}

Response Example

{
  "mentor_id": "mentor-042",
  "status": "paused",
  "auto_paused_at": "2026-03-31T00:00:00Z",
  "pause_reason": "certification_expiry",
  "pause_record_id": "pause-rec-0020",
  "website_hidden": true
}

GET /api/v1/pause-management/api/v1/pause-management/:mentorId/status

Get the current pause/active status for a mentor

Public

Response Example

{
  "mentor_id": "mentor-042",
  "status": "paused",
  "is_paused": true,
  "pause_start_date": "2026-03-01T00:00:00Z",
  "expected_return_date": "2026-04-01T00:00:00Z",
  "pause_reason": "certification_expiry",
  "active_pause_record_id": "pause-rec-0018"
}

Additional Metadata

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