operators

Register a new operator

Changed on

Creates the Keycloak account with a generated password and the operator role, enabled and with the email taken as verified, then the users and operators rows; the operator starts in onboarding and must change the password at first login. The password goes only to the PEC, with the blank contract: contract_pec_sent / contract_pec_error say how that went, and registration stands either way. 400 when the email is not on the company domain or the PEC is not an address; 409 when the email is already an account or its company mailbox already exists. POST /operators converts an existing user instead.

post/api/operators/register

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/register
  • Auth: HTTP bearer

Request body

user_idstring uuid nullable
vat_codestring nullable
ssn_codestring nullable
pecstring required

Where the contract and the credentials are sent

tax_regimestring nullable
billing_namestring nullable

Billing name (ragione sociale) used for invoicing; when set it replaces first/last name on Zucchetti

professionstring nullable
ibanstring nullable
work_placestring nullable
biostring nullable
professional_registration_numberstring nullable
professional_sectionstring nullable
regional_professional_orderstring nullable
statusstring nullable
status_reasonstring nullable
professional_insurance_expires_atstring date nullable
accepts_new_patientsboolean nullable
in_person_availabilityboolean

Disponibile per pazienti in presenza: declared profile preference, independent of calendar availability

default_appointment_costnumber nullable
operator_costnumber nullable
max_patientsinteger nullable
call_durationinteger nullable
presentation_videostring nullable
spoki_keystring nullable
spoki_emailstring nullable
slack_user_idstring nullable
emailstring required

Login email: the future company address nome.cognome@corabea.it

first_namestring required
last_namestring required
phonestring nullable

Response

Successful Response

user_idstring uuid nullable
vat_codestring nullable
ssn_codestring nullable
pecstring nullable
tax_regimestring nullable
billing_namestring nullable

Billing name (ragione sociale) used for invoicing; when set it replaces first/last name on Zucchetti

professionstring nullable
ibanstring nullable
work_placestring nullable
biostring nullable
professional_registration_numberstring nullable
professional_sectionstring nullable
regional_professional_orderstring nullable
statusstring nullable
status_reasonstring nullable
professional_insurance_expires_atstring date nullable
accepts_new_patientsboolean nullable
in_person_availabilityboolean

Disponibile per pazienti in presenza: declared profile preference, independent of calendar availability

default_appointment_costnumber nullable
operator_costnumber nullable
max_patientsinteger nullable
call_durationinteger nullable
presentation_videostring nullable
spoki_keystring nullable
spoki_emailstring nullable
slack_user_idstring nullable
idstring uuid required
created_atstring nullable
updated_atstring nullable
has_in_person_availabilityboolean
assignments_blocked_atstring date-time nullable

Set while an admin or supervisor blocks new patient assignments on this expert

assignments_block_reasonstring nullable

Why new assignments are blocked; shown wherever the expert cannot be picked

supervisor_namesstring nullable
assigned_patients_countinteger nullable

Patients with this operator as psychologist or nutritionist; list and profile only

coordinator_namesstring nullable

Comma-separated coordinators of the operator's supervisors; with include_supervisors only

handover_idstring uuid nullable

The operator's riassegnazione, if any. Open or closed: handover_closed_at is what says which.

handover_due_atstring nullable

Due time of that riassegnazione, when it has one.

handover_closed_atstring nullable

When it was closed. Null means open, so the section is still active for the operator and they cannot be deactivated yet.

handover_kindstring nullable

departure | return, for that riassegnazione.

handover_ends_atstring nullable

End of the leave, when it is a temporary replacement — 'in sostituzione fino al'.

contract_pec_sentboolean
contract_pec_errorstring nullable

Why the PEC failed; the Contratti tab can send it again

Changes

  • f23730d7b735Revision changes
    • breaking

      the request property became required

    • breaking

      request property list-of-types was narrowed by removing types null from media type application/json

    • breaking

      the request property's minLength was increased from 0 to 3

    • warning

      removed the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 2af59bd2c0e6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status