operators

Operator agenda (date range)

Changed on

Appointments and published, not-yet-booked availability. Defaults to the authenticated operator; an admin or coordinator must name one with operator_id, customer care may. A patient_id with no operator_id is the patient's own calendar across every expert; with a patient_id the range may be left out for the patient's whole history (narrowed to operator_id when given), which carries no availability.

get/api/operators/crm/agenda

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/operators/crm/agenda
  • Auth: HTTP bearer

Query parameters

from_datestring date-time nullable

Range start, ISO 8601 (inclusive).

to_datestring date-time nullable

Range end, ISO 8601 (exclusive).

modestring nullable

Filter appointments by mode: 'online' or 'in_person'.

type_codestring[]

Filter appointments by raw appointment type code(s); 'family' matches the family-session flag instead.

patient_idstring uuid nullable

Filter appointments by patient.

payment_fromstring date nullable

Keep appointments paid on/after this day (Europe/Rome).

payment_tostring date nullable

Keep appointments paid on/before this day (Europe/Rome).

statusstring[]

Keep only appointments in these statuses (DA_FARE, FATTO, DA_RIPROGRAMMARE, ANNULLATO, RIMBORSATO); every status when left out.

operator_idstring uuid nullable

Required for admin and coordinator callers; customer care may name any operator; anyone else only their own operator record.

Response

Successful Response

from_datestring nullable

Range start, ISO 8601 (inclusive); null for a patient's whole history.

to_datestring nullable

Range end, ISO 8601 (exclusive); null for a patient's whole history.

appointment_countinteger

Changes

  • 0be19a2c25c2Revision changes
    • info

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

  • babe5287135bRevision changes
    • info

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

    • info

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