journey

Get journey

Changed on

Get the journey with all phases and steps (no contents). Steps are automatically unlocked based on completed appointments (FATTO). Use GET /steps/{step_code} to get contents for a specific step. Virtual steps (like 'Iscrizione') are always completed for registered users.

get/api/journey

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/journey
  • Auth: HTTP bearer

Response

Successful Response

current_phase_codestring nullable

Current phase code based on appointments

psi_statusstring nullable

Current psychologist status from patient_status_at_date

nutri_statusstring nullable

Current nutritionist status from patient_status_at_date

total_stepsinteger required

Total number of steps in the journey

completed_stepsinteger required

Number of completed steps

completed_appointmentsinteger required

Number of completed appointments (FATTO)

has_valid_appointmentsboolean required

True if patient has at least one valid appointment. Frontend uses this to decide preview position: sotto video Giulia/Zaira (false) or sotto frase giornaliera (true)

Example response

{
  "completed_appointments": 4,
  "completed_steps": 3,
  "current_phase_code": "initial",
  "has_valid_appointments": true,
  "nutri_status": "attivo",
  "phases": [],
  "psi_status": "attivo",
  "total_steps": 12
}

Changes

  • 2a4daccec07cRevision changes
    • info

      added the optional property //// to the response with the status