{ "info": { "_postman_id": "anagensys-api-v1", "name": "AnagenSys API v1", "description": "Generated from the OpenAPI specification.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://anagen.pt/api/v1" }, { "key": "client_id", "value": "" }, { "key": "client_secret", "value": "" }, { "key": "token", "value": "" } ], "item": [ { "name": "Get an integration token", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials" }, { "key": "client_id", "value": "{{client_id}}" }, { "key": "client_secret", "value": "{{client_secret}}" } ] }, "url": { "raw": "{{base_url}}/oauth/token", "host": [ "{{base_url}}" ], "path": [ "oauth", "token" ] } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const corpo = pm.response.json();", "if (corpo.access_token) { pm.collectionVariables.set(\"token\", corpo.access_token); }" ] } } ] }, { "name": "Academia", "item": [ { "name": "My academy", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/academia", "host": [ "{{base_url}}" ], "path": [ "academia" ] }, "description": "Role paths (progress, deadline, overdue), courses published for the person, certificates and KPIs. «gerir» tells whether the person manages the academy." } }, { "name": "Certificate (with verification)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/academia/certificados/:codigo", "host": [ "{{base_url}}" ], "path": [ "academia", "certificados", ":codigo" ], "variable": [ { "key": "codigo", "value": "AX-1A2B-3C4D" } ] }, "description": "Own certificate or, for managers, anyone in the clinic. «integro» confirms the certificate signature." } }, { "name": "Course, lessons and test", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/academia/cursos/:id", "host": [ "{{base_url}}" ], "path": [ "academia", "cursos", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Lessons with text, video and file (signed links valid 60 min) and the test WITHOUT the correct answers." } }, { "name": "Mark a lesson as done", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/academia/cursos/:id/licoes/:licao/concluir", "host": [ "{{base_url}}" ], "path": [ "academia", "cursos", ":id", "licoes", ":licao", "concluir" ], "variable": [ { "key": "id", "value": "12" }, { "key": "licao", "value": "12" } ] }, "description": "" } }, { "name": "Submit the test", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/academia/cursos/:id/teste", "host": [ "{{base_url}}" ], "path": [ "academia", "cursos", ":id", "teste" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Grades, records the attempt and, with the pass mark, issues the certificate. Returns per-question correction (correct options and explanation). 409 when required lessons are missing.", "body": { "mode": "raw", "raw": "{\n \"respostas\": {\n \"31\": [\n 1\n ],\n \"32\": [\n 0,\n 2\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Team progress (managers)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/academia/equipa", "host": [ "{{base_url}}" ], "path": [ "academia", "equipa" ] }, "description": "" } } ] }, { "name": "Acompanhamento", "item": [ { "name": "Milestone detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/acompanhamento/marcos/:id", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "marcos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Photos vs day 0 (with ficha.fotografias), questionnaire, NPS, closed loop planned/projected/obtained per zone (with ficha.plano or ficha.captura), metrics over time (with ficha.captura) and treatments (prescription only with ficha.clinica)." } }, { "name": "Save NPS, measurements and links", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/acompanhamento/marcos/:id", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "marcos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "densidade_obtida, densidades_zona and metricas require ficha.captura:edit; notes require ficha.clinica.", "body": { "mode": "raw", "raw": "{\n \"nps\": 9,\n \"densidades_zona\": {\n \"linha_frontal\": 23.4,\n \"coroa\": 17.8\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change the status (board)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/acompanhamento/marcos/:id/estado", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "marcos", ":id", "estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "«falhado» creates a recovery task for reception; «concluido» fires the marco.concluido webhook.", "body": { "mode": "raw", "raw": "{\n \"estado\": \"revisto\",\n \"ordem\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ask the patient for the milestone photos", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/acompanhamento/marcos/:id/pedir-fotos", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "marcos", ":id", "pedir-fotos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Portal notification and service message (channel from Settings), in the patient's language and without clinical details." } }, { "name": "Recovery task for reception", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/acompanhamento/marcos/:id/recuperacao", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "marcos", ":id", "recuperacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"nota\": \"Sem resposta às mensagens do mês 2.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Milestone board", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/acompanhamento/quadro", "host": [ "{{base_url}}" ], "path": [ "acompanhamento", "quadro" ], "query": [ { "key": "marco", "value": "", "disabled": true }, { "key": "paciente_id", "value": "", "disabled": true }, { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "so_atraso", "value": "", "disabled": true } ] }, "description": "Columns by status with cards (patient, milestone, due date, days, overdue, NPS, photos pending), KPIs. Completed/failed only from the last 60 days." } } ] }, { "name": "Agenda", "item": [ { "name": "Professional external calendars", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/calendarios", "host": [ "{{base_url}}" ], "path": [ "agenda", "calendarios" ] }, "description": "Google Calendar and Microsoft 365: whether enabled in the clinic and the person’s connection (status, masked account, preferences, last sync, counts). Tokens never leave the server." } }, { "name": "Sync now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/calendarios/sincronizar", "host": [ "{{base_url}}" ], "path": [ "agenda", "calendarios", "sincronizar" ] }, "description": "Syncs the person’s connections both ways (the scheduler does it every 10 minutes)." } }, { "name": "Disconnect the calendar", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/calendarios/:fornecedor/desligar", "host": [ "{{base_url}}" ], "path": [ "agenda", "calendarios", ":fornecedor", "desligar" ], "variable": [ { "key": "fornecedor", "value": "1" } ] }, "description": "Deletes sent appointments in the external calendar (by default), revokes the authorisation when the provider allows it, deletes tokens and read blocks." } }, { "name": "Start the connection (OAuth)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/calendarios/:fornecedor/ligar", "host": [ "{{base_url}}" ], "path": [ "agenda", "calendarios", ":fornecedor", "ligar" ], "variable": [ { "key": "fornecedor", "value": "1" } ] }, "description": "Returns the provider authorisation URL (OAuth 2.0 with PKCE, single-use state valid for 10 minutes). The app opens it in the system browser; the provider returns to /agenda/calendarios/retorno/{fornecedor}, which stores the encrypted tokens and runs the first sync." } }, { "name": "Connection preferences", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/calendarios/:fornecedor/preferencias", "host": [ "{{base_url}}" ], "path": [ "agenda", "calendarios", ":fornecedor", "preferencias" ], "variable": [ { "key": "fornecedor", "value": "1" } ] }, "description": "«subir_marcacoes»: send appointments (no patient data); «bloquear_agenda»: external commitments remove slots and raise conflicts." } }, { "name": "Calendar configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/configuracao", "host": [ "{{base_url}}" ], "path": [ "agenda", "configuracao" ] }, "description": "Active appointment types (duration, colour, margins, teleconsultation, surgery, mandatory room, deposit, online booking), calendar professionals (with working hours or a clinical profile), active staff, rooms, equipment, interpreters, calendar start and end hours (Settings › Calendar), statuses with label and tone, and whether the caller can edit. No side effects." } }, { "name": "Free slots for an appointment type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/disponibilidade", "host": [ "{{base_url}}" ], "path": [ "agenda", "disponibilidade" ], "query": [ { "key": "tipo_id", "value": "", "disabled": false }, { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "profissional_id", "value": "", "disabled": true } ] }, "description": "Computes on the server the slots between «de» and «ate» (maximum 31 days), optionally for one professional: working hours admitting the type, approved absences, holidays, existing appointments with margins, the type minimum notice (and at least 5 minutes) and a free room when the type requires a room or is a surgery. Step and maximum number of slots in Settings › Calendar (15 min and 300 by default). Sorted by time. No side effects." } }, { "name": "Calendar events between two dates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/eventos", "host": [ "{{base_url}}" ], "path": [ "agenda", "eventos" ], "query": [ { "key": "inicio", "value": "", "disabled": true }, { "key": "fim", "value": "", "disabled": true }, { "key": "colunas", "value": "", "disabled": true }, { "key": "cor", "value": "", "disabled": true }, { "key": "f[profissional_id]", "value": "", "disabled": true }, { "key": "f[sala_id]", "value": "", "disabled": true }, { "key": "f[tipo_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true } ] }, "description": "Appointments within the caller scope (scope «own»: their appointments and those of their patients), type preparation and cleaning margins, approved absences and holidays. Without a status filter, cancelled and rescheduled ones are left out. Maximum range 62 days (default today → +7 days). In the API «url» is always null and dates carry an offset; holidays come with the date only. Up to 2000 appointments. meta.total counts every returned event." } }, { "name": "Active waiting list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/lista-espera", "host": [ "{{base_url}}" ], "path": [ "agenda", "lista-espera" ] }, "description": "Active or already contacted entries (up to 100), by priority (high, normal, low) and age. When a slot is released (cancellation or reschedule more than 1 h ahead), the first matching entry becomes «contactado» with the offered time and reception gets a task. Entries are managed through the generic waiting-list resource." } }, { "name": "Create appointment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes" ] }, "description": "Validates the fields (allowlist) and checks conflicts on the server for the range widened by the type margins. Blocking (409 «conflito»): professional or participant already busy, room above capacity, equipment or interpreter booked, approved absence, minimum notice on bookings with origin portal/site/agent. Warnings (409 «conflito_aviso»): holiday, outside working hours, professional without working hours, past date — resend with \"forcar\": true to accept; accepted warnings come back in «avisos». Effects: appointment history, audit, timeline event on the patient/lead, notification to the professional (when not the creator), deposit request in the commercial module when the type requires it, teleconsultation created when the type is a teleconsultation, waiting-list entry set to «marcado» and the marcacao.criada webhook.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"tipo_id\": 3,\n \"inicio\": \"2026-11-03T10:00:00+00:00\",\n \"profissional_id\": 7,\n \"sala_id\": 12,\n \"recursos\": [\n 21\n ],\n \"participantes\": [\n {\n \"utilizador_id\": 15,\n \"papel\": \"assistente\"\n }\n ],\n \"origem\": \"equipa\",\n \"episodio_id\": 77,\n \"notas\": \"Pede para ser contactado depois das 18:00.\",\n \"forcar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Check conflicts without saving", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/verificar", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", "verificar" ] }, "description": "Same rules as creation, saving nothing (to show conflicts live in the form). Validation errors come as conflicts with codigo «validacao», blocking and with the field. «ignorar» excludes an existing appointment (the same one, when changing it). Patient and professional are not required here.", "body": { "mode": "raw", "raw": "{\n \"tipo_id\": 3,\n \"inicio\": \"2026-11-03T10:00:00+00:00\",\n \"profissional_id\": 7,\n \"sala_id\": 12,\n \"participantes\": [\n 15\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Appointment detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Names, type, resources, participants, linked teleconsultation, reschedule chain, type cancellation policy, history (50 rows) and the actions available for the status and the caller permission. No clinical content. Out of scope answers 404. The read is audited." } }, { "name": "Change status (confirm, arrived, complete, no-show, cancel)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id/estado", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id", "estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The actions available at each moment come in M6Marcacao.acoes. confirmar (pedido/marcada → confirmada; marcacao.confirmada webhook). chegou (check-in → em_curso; opens the «admission» station on the day board and notifies the professional). concluir (→ concluida; «exit» station). faltou (→ faltou; high-priority «recover no-show» task for reception due in 1 day and a timeline event; the type deposit-loss rule goes into the task). cancelar (only pedido/marcada/confirmada → cancelada; optional reason up to 255 characters; notifies the professional, emails the patient when Settings › Calendar › notify changes is on, offers the slot to the first matching waiting-list entry — task for reception — and fires the marcacao.cancelada webhook). All are recorded in history and audit. Incompatible status → 409 «estado_invalido».", "body": { "mode": "raw", "raw": "{\n \"acao\": \"confirmar\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send the reminder now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id/lembrete", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id", "lembrete" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Sends the patient (or lead) the reminder with date, time and the public link to confirm, cancel or reschedule, through the channels in Settings › Calendar › reminder channels (email, SMS, WhatsApp), in the patient language. «Service» purpose and no clinical details (not even the act type); teleconsultations add the video consultation note. Effects: lembrete_enviado_em and a history row. 422 «lembrete_falhou» when no channel delivered, there is no contact or the appointment is not pedido/marcada/confirmada." } }, { "name": "Public appointment link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id/ligacao", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id", "ligacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Address /marcacao/ for the patient to confirm, cancel, reschedule, report a delay, check in or join the teleconsultation waiting room, without a session. Valid for at least 7 days (until 2 days after the appointment end); it can be resent without invalidating the previous one. With \"renovar\": true the validity changes and every older link stops working. Only the cryptographic digest of the token is stored.", "body": { "mode": "raw", "raw": "{\n \"renovar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Move or resize (calendar)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id/mover", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id", "mover" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only in pedido, marcada or confirmada (409 «estado_invalido»). Without «fim» the duration is kept. It can change professional or room (drag between columns). Conflicts as on creation (409 «conflito» / «conflito_aviso»; resend with \"forcar\": true). A time change on a confirmed appointment returns it to «marcada» (the patient confirms again) and resets the reminder; with Settings › Calendar › notify changes, the patient receives an email (service purpose, no clinical details) with the new time and the public link. Effects: history and audit. A surgical block is moved through the surgery map: the request is forwarded to the surgery reservation (requires «bloco.marcar» edit) and the response is the reservation one. Response times are clinic local time, without offset.", "body": { "mode": "raw", "raw": "{\n \"inicio\": \"2026-11-03T11:00:00+00:00\",\n \"profissional_id\": 7,\n \"forcar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reschedule (new appointment linked to the previous one)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/marcacoes/:id/remarcar", "host": [ "{{base_url}}" ], "path": [ "agenda", "marcacoes", ":id", "remarcar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates a new appointment with the same patient/lead, type, duration, room, resources, participants and notes (optionally another professional), linked to the previous one through «remarcada_de»; the previous one becomes «remarcada». Conflicts as on creation (409; resend with \"forcar\": true to accept warnings). Effects: history on both, a not-yet-started teleconsultation moves to the new appointment, email to the patient with the new time and the public link (Settings › Calendar › notify changes), slot offered to the waiting list and the marcacao.criada webhook for the new appointment.", "body": { "mode": "raw", "raw": "{\n \"inicio\": \"2026-11-05T15:00:00+00:00\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Occupancy by professional or room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/ocupacao", "host": [ "{{base_url}}" ], "path": [ "agenda", "ocupacao" ], "query": [ { "key": "inicio", "value": "", "disabled": true }, { "key": "fim", "value": "", "disabled": true }, { "key": "colunas", "value": "", "disabled": true } ] }, "description": "Available hours (from working hours; rooms without hours count the calendar hours on weekdays), hours taken by occupying appointments, percentage and number of appointments. Estimated revenue (base price of the type procedures) is only returned to users with «financeiro.valores» and scope «all». Default: current week." } }, { "name": "Kiosk check-in (code or QR)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/quiosque/codigo", "host": [ "{{base_url}}" ], "path": [ "agenda", "quiosque", "codigo" ] }, "description": "Today’s 6-character check-in code or the QR content (personal link). Only today’s in-person appointments within the configured window. Minimal answer: first name and initial, time, room, professional.", "body": { "mode": "raw", "raw": "{\n \"codigo\": \"K7M 3QX\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Kiosk check-in (mobile and date of birth)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/quiosque/telefone", "host": [ "{{base_url}}" ], "path": [ "agenda", "quiosque", "telefone" ] }, "description": "Matched by the last 9 phone digits and date of birth; today’s nearest appointment without check-in." } }, { "name": "Reception check-in kiosks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/quiosques", "host": [ "{{base_url}}" ], "path": [ "agenda", "quiosques" ] }, "description": "Tablets with the /quiosque/ address." } }, { "name": "Create a kiosk", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/quiosques", "host": [ "{{base_url}}" ], "path": [ "agenda", "quiosques" ] }, "description": "256-bit code; only the digest is stored. The address is returned only once." } }, { "name": "Revoke a kiosk", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/quiosques/:id/revogar", "host": [ "{{base_url}}" ], "path": [ "agenda", "quiosques", ":id", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Personal calendar link status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/sincronizar", "host": [ "{{base_url}}" ], "path": [ "agenda", "sincronizar" ] }, "description": "Whether the person has an active subscription link (iCalendar format, read-only), its first 8 characters to recognise it and the last use. The full link is never returned here." } }, { "name": "Generate the personal calendar link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/sincronizar", "host": [ "{{base_url}}" ], "path": [ "agenda", "sincronizar" ] }, "description": "Generates a new link (revokes the previous one) to subscribe to the own appointments in an external calendar application. The link is shown only once. Data protection: the external calendar never receives the patient name or clinical details — only the act type, the room and the link to open the appointment in AnagenSys (which requires a session). 256-bit token; only the cryptographic digest is stored. Limit: 10 requests per 10 minutes. Effects: audit." } }, { "name": "Revoke the personal calendar link", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/sincronizar", "host": [ "{{base_url}}" ], "path": [ "agenda", "sincronizar" ] }, "description": "The subscription stops receiving data immediately. Effects: «revoke» audit." } } ] }, { "name": "Fluxo do dia", "item": [ { "name": "Day flow board", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/fluxo", "host": [ "{{base_url}}" ], "path": [ "agenda", "fluxo" ], "query": [ { "key": "data", "value": "", "disabled": true } ] }, "description": "One card per appointment of the day (calendar scope) in its station column: to arrive, admission, preparation, extraction, implantation, recovery, exit. Includes time in the current station, delays (still to arrive 10 minutes after the time) and a summary with average minutes per station. Surgeries move station automatically with the surgical panel phases." } }, { "name": "Change the station of an appointment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/agenda/fluxo/:id/posto", "host": [ "{{base_url}}" ], "path": [ "agenda", "fluxo", ":id", "posto" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Closes the current station (stores the time) and opens the new one; checks in when not done yet. «saida» completes the appointment; the other stations set it in progress. «por_chegar» undoes a mistake: clears the station and check-in and returns to confirmed/booked. Refused on cancelled, rescheduled or no-show appointments (409 «estado_invalido»). Effects: history.", "body": { "mode": "raw", "raw": "{\n \"posto\": \"admissao\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Waiting-room screen", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/agenda/sala-espera", "host": [ "{{base_url}}" ], "path": [ "agenda", "sala-espera" ] }, "description": "For the waiting-room television (screen «sala_espera»): who is being seen (up to 6) and who is next (up to 8) today, with first name and surname initial only, the room and the time. Surgical blocks are excluded." } } ] }, { "name": "Ajuda", "item": [ { "name": "Help articles (list, search or contextual)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ajuda", "host": [ "{{base_url}}" ], "path": [ "ajuda" ], "query": [ { "key": "q", "value": "", "disabled": true }, { "key": "ecra", "value": "", "disabled": true } ] }, "description": "No parameters: visible articles (team: by permissions; patient: portal only). ?q= searches. ?ecra= returns that screen article (404 if none)." } }, { "name": "System Manual (numbered chapters and sections)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ajuda/manual", "host": [ "{{base_url}}" ], "path": [ "ajuda", "manual" ], "query": [ { "key": "conteudo", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "One article (sanitised HTML and related)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ajuda/:chave", "host": [ "{{base_url}}" ], "path": [ "ajuda", ":chave" ], "variable": [ { "key": "chave", "value": "1" } ] }, "description": "" } } ] }, { "name": "Ambiente", "item": [ { "name": "Server environment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ambiente", "host": [ "{{base_url}}" ], "path": [ "ambiente" ] }, "description": "Public (60 requests per minute per address). Never includes addresses or the list of authorised destinations.", "auth": { "type": "noauth" } } } ] }, { "name": "Avisos no telemóvel", "item": [ { "name": "My devices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/aparelhos", "host": [ "{{base_url}}" ], "path": [ "aparelhos" ] }, "description": "The person’s devices with a live session (ended sessions are deleted). «este» = the request’s session. Never returns tokens." } }, { "name": "Register this device", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/aparelhos", "host": [ "{{base_url}}" ], "path": [ "aparelhos" ] }, "description": "Registers or updates the device of the current app session. The token is encrypted; the same device in another account or clinic is removed there. One device per session; at most 10 per person. Limit: 30 requests/10 min.", "body": { "mode": "raw", "raw": "{\n \"token\": \"f3k9…:APA91b…\",\n \"fornecedor\": \"fcm\",\n \"plataforma\": \"android\",\n \"ambiente\": \"producao\",\n \"lingua\": \"pt-PT\",\n \"nome\": \"Samsung SM-S921B\",\n \"versao_app\": \"1.0.0+1\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Public notification configuration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/aparelhos/configuracao", "host": [ "{{base_url}}" ], "path": [ "aparelhos", "configuracao" ] }, "description": "Whether notifications are on and, per platform, whether it is ready, the delivery route and the PUBLIC project identifiers for the app to start the service. Never returns credentials. Also returns the categories with the person’s preference." } }, { "name": "Notification service status (super administrators)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/aparelhos/plataforma", "host": [ "{{base_url}}" ], "path": [ "aparelhos", "plataforma" ] }, "description": "Configuration (no secrets), devices per platform and last-24h notifications per state, across clinics — counts only. 403 for non super administrators." } }, { "name": "Stop receiving on this device", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/aparelhos/:id", "host": [ "{{base_url}}" ], "path": [ "aparelhos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Send test notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/aparelhos/:id/testar", "host": [ "{{base_url}}" ], "path": [ "aparelhos", ":id", "testar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Sends a test notification to the person’s own device. ok:false when the service refuses (invalid token → device deleted). 409 when notifications are off or in a test environment. Limit: 5/10 min." } }, { "name": "Preferences per category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "notificacoes", "preferencias" ] }, "description": "Team: messages, schedule, tasks, documents, payments, alerts, general. Patients: messages, schedule, documents, payments, general. No choice = on." } }, { "name": "Save preferences", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/notificacoes/preferencias", "host": [ "{{base_url}}" ], "path": [ "notificacoes", "preferencias" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"categorias\": {\n \"agenda\": false,\n \"mensagens\": true\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Atividade", "item": [ { "name": "Activity log (list)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade", "host": [ "{{base_url}}" ], "path": [ "atividade" ], "query": [ { "key": "f[ator]", "value": "", "disabled": true }, { "key": "f[ator_tipo]", "value": "", "disabled": true }, { "key": "f[acao]", "value": "", "disabled": true }, { "key": "f[familia]", "value": "", "disabled": true }, { "key": "f[paciente]", "value": "", "disabled": true }, { "key": "f[alvo_tipo]", "value": "", "disabled": true }, { "key": "f[alvo_id]", "value": "", "disabled": true }, { "key": "f[pagina]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[de]", "value": "", "disabled": true }, { "key": "f[ate]", "value": "", "disabled": true }, { "key": "f[dia]", "value": "", "disabled": true }, { "key": "f[hora]", "value": "", "disabled": true }, { "key": "f[q]", "value": "", "disabled": true }, { "key": "f[fora_horas]", "value": "", "disabled": true }, { "key": "clinica", "value": "", "disabled": true }, { "key": "depois_id", "value": "", "disabled": true } ] }, "description": "Newest first; default period: last 7 days (max 366). Filters in f[…] (or top level, except pagina). depois_id returns only newer rows (up to 100) for live updates. meta: {pagina, por_pagina, total, ultimo_id, filtros, periodo, clinica, exportar}." } }, { "name": "Export CSV (requires «export»; the export is logged)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade/exportar", "host": [ "{{base_url}}" ], "path": [ "atividade", "exportar" ], "query": [ { "key": "f[ator]", "value": "", "disabled": true }, { "key": "f[ator_tipo]", "value": "", "disabled": true }, { "key": "f[acao]", "value": "", "disabled": true }, { "key": "f[familia]", "value": "", "disabled": true }, { "key": "f[paciente]", "value": "", "disabled": true }, { "key": "f[alvo_tipo]", "value": "", "disabled": true }, { "key": "f[alvo_id]", "value": "", "disabled": true }, { "key": "f[pagina]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[de]", "value": "", "disabled": true }, { "key": "f[ate]", "value": "", "disabled": true }, { "key": "f[dia]", "value": "", "disabled": true }, { "key": "f[hora]", "value": "", "disabled": true }, { "key": "f[q]", "value": "", "disabled": true }, { "key": "f[fora_horas]", "value": "", "disabled": true }, { "key": "clinica", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "App navigation (opened screens, batched)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/atividade/navegacao", "host": [ "{{base_url}}" ], "path": [ "atividade", "navegacao" ] }, "description": "Up to 50 events per batch; path only (no query), screen/resource key and numeric id. The same event is not repeated within 10 minutes; cap of 120 rows per account per 10 minutes. Effect: «abriu»/«viu» rows in the activity log.", "body": { "mode": "raw", "raw": "{\n \"eventos\": [\n {\n \"tipo\": \"ecra\",\n \"rota\": \"/e/funil\",\n \"chave\": \"funil\",\n \"em\": \"2026-10-28T10:01:00Z\"\n },\n {\n \"tipo\": \"ecra\",\n \"rota\": \"/r/pacientes/12\",\n \"chave\": \"pacientes\",\n \"id\": 12\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "The person’s day", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade/pessoa/:id", "host": [ "{{base_url}}" ], "path": [ "atividade", "pessoa", ":id" ], "query": [ { "key": "dia", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "People in the log (90 days), for the filter", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade/pessoas", "host": [ "{{base_url}}" ], "path": [ "atividade", "pessoas" ] }, "description": "" } }, { "name": "Summary of the filtered period", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade/resumo", "host": [ "{{base_url}}" ], "path": [ "atividade", "resumo" ], "query": [ { "key": "f[ator]", "value": "", "disabled": true }, { "key": "f[ator_tipo]", "value": "", "disabled": true }, { "key": "f[acao]", "value": "", "disabled": true }, { "key": "f[familia]", "value": "", "disabled": true }, { "key": "f[paciente]", "value": "", "disabled": true }, { "key": "f[alvo_tipo]", "value": "", "disabled": true }, { "key": "f[alvo_id]", "value": "", "disabled": true }, { "key": "f[pagina]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[de]", "value": "", "disabled": true }, { "key": "f[ate]", "value": "", "disabled": true }, { "key": "f[dia]", "value": "", "disabled": true }, { "key": "f[hora]", "value": "", "disabled": true }, { "key": "f[q]", "value": "", "disabled": true }, { "key": "f[fora_horas]", "value": "", "disabled": true }, { "key": "clinica", "value": "", "disabled": true } ] }, "description": "totals; per action; people (most active); pages; most viewed patients; series {granularity: hour|day, points}; em_foco [{tipo, tom, icone, titulo, texto, filtro}]." } }, { "name": "One log row", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/atividade/:id", "host": [ "{{base_url}}" ], "path": [ "atividade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Auditoria", "item": [ { "name": "Audit log", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auditoria", "host": [ "{{base_url}}" ], "path": [ "auditoria" ], "query": [ { "key": "ator_id", "value": "", "disabled": true }, { "key": "paciente_id", "value": "", "disabled": true }, { "key": "acao", "value": "", "disabled": true }, { "key": "recurso", "value": "", "disabled": true }, { "key": "origem", "value": "", "disabled": true }, { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Filters at the top level (ator_id, paciente_id, acao, recurso, origem, de, ate) or in f[…]. Dates YYYY-MM-DD. Requires Audit › View." } }, { "name": "Export CSV (requires «export»; the export is logged)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auditoria/exportar", "host": [ "{{base_url}}" ], "path": [ "auditoria", "exportar" ] }, "description": "" } }, { "name": "Verify chain integrity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auditoria/verificar", "host": [ "{{base_url}}" ], "path": [ "auditoria", "verificar" ] }, "description": "" } }, { "name": "Verify chain integrity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auditoria/verificar", "host": [ "{{base_url}}" ], "path": [ "auditoria", "verificar" ] }, "description": "" } }, { "name": "Row detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auditoria/:id", "host": [ "{{base_url}}" ], "path": [ "auditoria", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Autenticação", "item": [ { "name": "Sign in (step 2: authenticator or recovery code)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/2fa", "host": [ "{{base_url}}" ], "path": [ "auth", "2fa" ] }, "description": "On first setup it also returns codigos_recuperacao (show only once).", "body": { "mode": "raw", "raw": "{\n \"desafio\": \"Zk3…\",\n \"codigo\": \"492817\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Sign in (step 1: email and password)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/entrar", "host": [ "{{base_url}}" ], "path": [ "auth", "entrar" ] }, "description": "Returns the next step: {estado:\"2fa\", desafio} (with configurar:true, segredo and otpauth when the second factor is not set up yet), {estado:\"sigilo\", desafio, termo} or, once complete, the tokens. The challenge is valid for 10 minutes and 5 attempts.", "body": { "mode": "raw", "raw": "{\n \"email\": \"ines@clinica.pt\",\n \"palavra_passe\": \"••••••••••••\",\n \"dispositivo\": \"Pixel 9\",\n \"plataforma\": \"android\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Refresh tokens (rotation)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auth/renovar", "host": [ "{{base_url}}" ], "path": [ "auth", "renovar" ] }, "description": "Each refresh returns a new pair and invalidates the previous one. Reusing a refresh token that was already used ends the whole session (family) for safety — the app returns to sign-in.", "auth": { "type": "noauth" } } }, { "name": "Sign out", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/auth/sair", "host": [ "{{base_url}}" ], "path": [ "auth", "sair" ] }, "description": "Ends the current session; with {todas:true} ends every session of the account (web and app)." } }, { "name": "Sign in (step 3: accept the confidentiality term)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/sigilo", "host": [ "{{base_url}}" ], "path": [ "auth", "sigilo" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"desafio\": \"Zk3…\",\n \"aceitar\": true\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } } ] }, { "name": "Escudo de entrada", "item": [ { "name": "Sign in: choose the clinic (email with accounts in several)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/clinica", "host": [ "{{base_url}}" ], "path": [ "auth", "clinica" ] }, "description": "When /auth/entrar answers {estado:\"clinica\", desafio, clinicas:[…]}, send the challenge and the chosen clinic id. It continues with that account’s second factor and confidentiality agreement (same responses as /auth/entrar). Only accounts with the same password are listed; suspended licence → 403 licenca_suspensa.", "body": { "mode": "raw", "raw": "{\n \"desafio\": \"Zk3…\",\n \"clinica_id\": 4\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Device verification challenge (team)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/auth/desafio", "host": [ "{{base_url}}" ], "path": [ "auth", "desafio" ] }, "description": "Stateless (signed), valid for 300 s in the app, single use. With dispositivo_confiavel the verification is one level lighter. dados is null when the shield is off. Limited to 30 requests per minute per address.", "body": { "mode": "raw", "raw": "{\n \"dispositivo_confiavel\": \"eyJ2IjoxLCJk….a91f…\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Device verification challenge (patient portal)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/auth/desafio", "host": [ "{{base_url}}" ], "path": [ "portal", "auth", "desafio" ] }, "description": "Same as /auth/desafio, for requesting a code, signing in and registering in the portal. Send X-AX-Clinica with the clinic code.", "auth": { "type": "noauth" } } } ] }, { "name": "Exportação", "item": [ { "name": "My BI tokens", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bi/tokens", "host": [ "{{base_url}}" ], "path": [ "bi", "tokens" ] }, "description": "" } }, { "name": "Create a BI read token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bi/tokens", "host": [ "{{base_url}}" ], "path": [ "bi", "tokens" ] }, "description": "The token (axbi_…) is only returned in this response. Use it on GET /bi/.csv|json at the site root, with «Authorization: Bearer» or «?token=», and it reads with the person's CURRENT permissions.", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Painel da direção\",\n \"conjuntos\": [\n \"indicadores_vendas\",\n \"indicadores_financeiros\"\n ],\n \"dias\": 365\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke BI token", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bi/tokens/:id", "host": [ "{{base_url}}" ], "path": [ "bi", "tokens", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Full clinic exports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/exportacoes", "host": [ "{{base_url}}" ], "path": [ "exportacoes" ] }, "description": "State of each request (pedido, a_gerar, concluida, erro, expirada), size, tables, SHA-256 and a 15-minute signed link to download in the browser." } }, { "name": "Request a full export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/exportacoes", "host": [ "{{base_url}}" ], "path": [ "exportacoes" ] }, "description": "ZIP with one CSV per clinic table, manifest (tables, columns, rows, SHA-256) and file list. Credentials and secrets are never exported; encrypted fields stay encrypted. Generated in the background; one request at a time.\n\nEffects: audit (with reason); notification to the requester and webhook exportacao.concluida when ready.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Cópia anual para arquivo\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Mapa de cirurgias", "item": [ { "name": "Tick or untick a checklist item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/checklists/:id/itens", "host": [ "{{base_url}}" ], "path": [ "bloco", "checklists", ":id", "itens" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires «bloco.registo» edit (pre-operative checklists also accept «bloco.marcar» edit). Records who and when; the checklist completes when every mandatory item is done and reopens if one is unticked; the pre-operative one feeds the map «checklist» indicator. Completed or cancelled surgery → 409. Missing index → 422. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"indice\": 1,\n \"feito\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a surgery manually", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias" ] }, "description": "For surgeries without a proposal (for example an already paid second session): it stays pre-booked, with its own number and fitness «to assess». The act value is only accepted from users with «financeiro.valores» edit. With «inicio» and «sala_id» it reserves the day and room at once (rules of POST /bloco/cirurgias/{id}/reservar); if the reservation fails due to a conflict, the surgery stays created as pre-booked (see GET /bloco/por-agendar) and the request returns 409. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"tecnica\": \"FUE\",\n \"enxertos_planeados\": 2850,\n \"inicio\": \"2026-11-18T08:30:00+00:00\",\n \"sala_id\": 5\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Surgery detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Status, planned times, room, technique, planned grafts, fitness, validation, indicators, team, pre-operative checklists and the actions available to the caller. Per-profile view: the act value is only returned with «financeiro.valores» (scope «all», or on surgeries where the person takes part or made the reservation); each person fees are only returned with scope «all» (otherwise only their own). The read is audited." } }, { "name": "Pre-operative tests received", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/analises", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "analises" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Turns the «tests» indicator on or off. Requires «bloco.marcar» edit or «bloco.registo» edit. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"ok\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pre-operative fitness (medical decision)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/aptidao", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "aptidao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires «approve» on «bloco.marcar». A fitness other than «apto» on a validated or confirmed surgery returns it to «reserved» and notifies the validator. Effects: «approve» audit.", "body": { "mode": "raw", "raw": "{\n \"aptidao\": \"apto\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel the surgery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only in plannable statuses (409). Reason required (up to 255 characters). Also cancels the calendar block and notifies the team with the reason. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Paciente pediu para adiar por motivos profissionais.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create the pre-operative checklists", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/checklist", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "checklist" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates (only once) the checklists of the active templates of the «pre-operative» phase (surgical safety checklist). The action is offered in M6Cirurgia.acoes to those who record in the theatre or view surgical bookings. Returns the ids and the updated detail." } }, { "name": "Confirm the surgery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/confirmar", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "confirmar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only from «validated» (409). Does not confirm without a valid surgical consent (checked in the compliance module when it exists; otherwise the latest core «cirurgico» consent) — 422 «consentimento_em_falta» — nor without fitness «apto» — 422 «aptidao_em_falta». Effects: calendar block confirmed, episode → «pre-operative», clinical timeline event, team notification and audit." } }, { "name": "Assign a person to the team (or change the role)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/equipa", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "equipa" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "When the surgery has a date, checks whether the person is busy or absent (409 «conflito»; warnings such as «no working hours» are accepted with \"forcar\": true). On a validated or confirmed surgery it returns to «reserved» and the validator is notified. Updates the calendar block participants and notifies the person (when not the one assigning). Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"utilizador_id\": 19,\n \"papel\": \"enfermeiro\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reserve or change the day and room", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/reservar", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "reservar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only in pre-booked, reserved, validated or confirmed (409 «estado_invalido»). Without «fim», the duration is kept (or the surgery type duration, 360 min by default). Conflicts checked for the surgeon, the team and the room, without working hours (409 «conflito» / «conflito_aviso»; resend with \"forcar\": true). A pre-booked surgery becomes reserved and the episode «scheduled»; changing the day or room of a validated or confirmed surgery returns it to «reserved» (new validation) and notifies the validator. Creates or updates the calendar block (surgery-type appointment, with the team as participants) so that calendar and map share conflicts. Effects: appointment history and audit. Response times are clinic local time, without offset; the updated detail comes in «cirurgia».", "body": { "mode": "raw", "raw": "{\n \"inicio\": \"2026-11-18T08:30:00+00:00\",\n \"sala_id\": 5,\n \"forcar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a person from the team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/retirar", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "retirar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only in plannable statuses (409). On a validated or confirmed surgery it returns to «reserved» and the validator is notified. Updates the calendar block. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"utilizador_id\": 19\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate team and fitness (doctor)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/cirurgias/:id/validar", "host": [ "{{base_url}}" ], "path": [ "bloco", "cirurgias", ":id", "validar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires «approve» on «bloco.marcar». Only from «reserved» (409). Requires date and room, a surgeon on the team and fitness «apto» (422 «validacao» with fields inicio, equipa, aptidao). Effects: «approve» audit and notification to the person who reserved." } }, { "name": "Weekly clinical team roster", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/escala", "host": [ "{{base_url}}" ], "path": [ "bloco", "escala" ], "query": [ { "key": "data", "value": "", "disabled": true } ] }, "description": "Week (Monday to Sunday) containing «data»: one row per clinical team member (doctors, nursing, technicians) with each day surgeries (time, room, role, status) and approved absences. People with surgeries that week come first." } }, { "name": "Surgery map by room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/mapa", "host": [ "{{base_url}}" ], "path": [ "bloco", "mapa" ], "query": [ { "key": "inicio", "value": "", "disabled": true }, { "key": "fim", "value": "", "disabled": true }, { "key": "utilizador", "value": "", "disabled": true } ] }, "description": "Non-cancelled surgeries dated in the range (up to 500), with the surgeon colour, the room as «recurso», the 5 indicators (confirmed, deposit, consent, tests, checklist) and the team. «utilizador» shows only surgeries where the person is on the team. «editavel» tells whether the caller can change the surgery (bloco.marcar edit and a plannable status)." } }, { "name": "Theatre occupancy by room", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/ocupacao", "host": [ "{{base_url}}" ], "path": [ "bloco", "ocupacao" ], "query": [ { "key": "inicio", "value": "", "disabled": true }, { "key": "fim", "value": "", "disabled": true } ] }, "description": "Theatre rooms (or every room when none is flagged as theatre): available hours from the room working hours (without hours: Settings › Theatre › hours per weekday, 10 by default), hours used by reserved or later surgeries, percentage and number of surgeries. Default: current week." } }, { "name": "Pre-booked surgeries without a date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/por-agendar", "host": [ "{{base_url}}" ], "path": [ "bloco", "por-agendar" ] }, "description": "Pre-booked (accepted proposal with deposit, or created manually) still without a date, by age (up to 100), to drag onto the map." } } ] }, { "name": "Painel cirúrgico", "item": [ { "name": "Surgeries of the day to pick in the panel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel" ], "query": [ { "key": "data", "value": "", "disabled": true } ] }, "description": "Validated, confirmed, in-progress or completed surgeries planned to start on the day, by time, with the current phase and the team." } }, { "name": "Full panel state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id" ], "query": [ { "key": "atualizar", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "State synchronised between theatre tablets (poll every few seconds): surgery and timer (without pauses), phases with duration, team and operators, counts by FU type and moment, progress against the plan, batches with time out of body (warning and maximum in Settings › Theatre, 4 h and 6 h by default), transection, approved plan summary (with «ficha.plano» summary), nursing (only with clinical record access; otherwise {visivel:false}), checklists, discharge, permissions and voice-counting words. The first read without «atualizar» records the panel opening in the audit log; periodic refreshes should send atualizar=1." } }, { "name": "Open the surgical session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/abrir", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "abrir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only a confirmed surgery (409 «estado_invalido») and only with a valid surgical consent, checked again at this moment (422 «consentimento_em_falta»). Effects: surgery in progress with real start time and phase «admission», admission checklists created, appointment in progress with check-in, episode → «surgery», clinical timeline event and audit." } }, { "name": "Record (or update) the discharge", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/alta", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "alta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "During or after the session (409). Requires access to the patient clinical record. Instructions (default from Settings › Theatre; mandatory), medication (encrypted; only visible with clinical record access), emergency contact (default from Settings), grafts by FU type and total hairs (from implantation, or extraction when there is none), warranty certificate number the first time (Settings). With «lavagem_inicio» it books the first wash in the calendar (type «primeira_lavagem», confirmed, with conflict checks; resend with \"forcar\": true to accept warnings). Issues the discharge document in the documents module when it exists. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"instrucoes\": \"Dormir com a cabeça elevada nas primeiras 3 noites. Não molhar a zona recetora durante 48 h. Não usar chapéu apertado durante 10 dias.\",\n \"medicacao\": \"Paracetamol 1 g de 8 em 8 horas durante 3 dias, se houver dor.\",\n \"contacto_urgencia\": \"+351 210 000 000\",\n \"lavagem_inicio\": \"2026-11-20T10:00:00+00:00\",\n \"lavagem_profissional_id\": 19\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Transection sample", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/amostra", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "amostra" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "n grafts observed (1 to 1000) and how many were transected (0 to n), per operator. The session and per-operator rates are recomputed on the server and stored on closing. Open session (409).", "body": { "mode": "raw", "raw": "{\n \"amostra_n\": 100,\n \"transeccionados\": 3,\n \"operador_id\": 7\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Void a nursing record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/anular", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Correction by voiding with a mandatory reason (up to 255 characters): the original record is kept, flagged as voided, and stops counting (for example in the lidocaine dose). Missing or already voided record → 404. Completed or cancelled surgery → 409. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"registo_id\": 3301,\n \"motivo\": \"Dose registada em duplicado.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Tick an item of a session checklist", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/checklist", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "checklist" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Same rules as POST /bloco/checklists/{id}/itens, from the panel (checklist_id from M6Painel.checklists).", "body": { "mode": "raw", "raw": "{\n \"checklist_id\": 640,\n \"indice\": 0,\n \"feito\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Count grafts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/contar", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "contar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records grafts by FU type — 1, 2, 3 or 4 (4 = 4 or more hairs; counts as the number of hairs in Settings › Theatre, minimum 4) — at the extraction or implantation moment, per operator (default: the person recording), by touch, voice or pedal/keys. Quantity 1 by default, up to 50 at once to correct in bulk. Open session (409). Light response for the counting screen (without the full panel). Limit: 600 requests per minute.", "body": { "mode": "raw", "raw": "{\n \"tipo_uf\": 2,\n \"momento\": \"implantacao\",\n \"quantidade\": 1,\n \"origem\": \"toque\",\n \"operador_id\": 15\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Undo the last count", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/desfazer", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "desfazer" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Voids (clinical record: nothing is deleted) the last count of the last 10 minutes, or the one given in «contagem_id» if still in that window. No recent counts → 409 «nada_a_desfazer». Open session (409).", "body": { "mode": "raw", "raw": "{\n \"contagem_id\": 90412\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Nursing and anaesthesia record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/enfermagem", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "enfermagem" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Types: sinais_vitais, farmaco, dor, incidente, nota (fields and ranges in M6EnfSinaisVitais, M6EnfFarmaco, M6EnfDor, M6EnfIncidente, M6EnfNota). Data encrypted with the clinical key; the audit log only keeps field names. Requires access to the patient clinical record. Lidocaine (name containing lidoca/xiloca/lignoca): cumulative dose in mg (ml × concentration % × 10; mcg ÷ 1000; g × 1000) divided by weight; limit 4.5 mg/kg, or 7 mg/kg when every administration had adrenaline (Settings › Theatre); «aviso» from the warning percentage (80 % by default) and «perigo» when reaching the limit — in those cases the surgery team gets a notification (without clinical content). For lidocaine in ml the concentration is mandatory. A high-severity incident also notifies the team. Completed or cancelled surgery → 409.", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"farmaco\",\n \"dados\": {\n \"nome\": \"Lidocaína com adrenalina\",\n \"dose\": 34,\n \"unidade\": \"ml\",\n \"concentracao_pct\": 1,\n \"via\": \"local\",\n \"hora\": \"09:05\",\n \"lote\": \"LX2291\",\n \"adrenalina\": true,\n \"artigo_id\": 58\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Discharge sheet handed to the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/entregue", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "entregue" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records when the discharge sheet (grafts by FU type and total hairs) was handed over. No discharge recorded → 404. Effects: «print» audit." } }, { "name": "Change phase", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/fase", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "fase" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Open session (409). Closes the current phase (pauses deducted), opens the new one and creates its checklists (ids in «checklists_novas»). The appointment changes station on the day board (drawing/anaesthesia → preparation, extraction, implantation, dressing → recovery). Asking for the current phase returns the panel unchanged. Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"fase\": \"implantacao\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Close the session (definitive)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/fechar", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "fechar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Definitive: once closed, the session no longer accepts records. Requires \"confirmacao\" equal to the surgery number (case-insensitive; 422 «validacao»), recorded counts (422 «sem_contagens») and, when Settings › Theatre › mandatory vital signs is on, vital signs (422 «sinais_vitais_em_falta»). Only with the session open (409). Stores extracted and implanted grafts, grafts by FU type, total hairs (from implantation, or extraction when there is none) and the transection rate; closes the current phase and the batches not yet implanted; completes the appointment. Fires, when the modules exist (each one guarded — closing never fails because of them; result in «efeitos»: ok | erro | indisponivel): post-operative follow-up milestones, team fees, stock consumption of drugs with item and lot, episode → «post-operative» and the cirurgia.fechada webhook. Effects: clinical timeline event, team notification and audit.", "body": { "mode": "raw", "raw": "{\n \"confirmacao\": \"CIR-2026-0214\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Intra-operative photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/foto", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "foto" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only with the session open (409). Requires access to the patient clinical record or «ficha.fotografias» edit. Image validated by content, stored as an encrypted clinical file and linked to the clinical gallery (accepted) when the planning module exists. With a zone or note, it also creates a nursing note. Returns a 15-minute signed link." } }, { "name": "Batch implanted", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/implantar", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "implantar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Ends the batch time out of body (the first recorded time is kept) and allows correcting the quantity (0 to 5000). Missing batch → 404. Open session (409). On closing, batches not yet implanted close with the closing time.", "body": { "mode": "raw", "raw": "{\n \"lote_id\": 52,\n \"quantidade\": 690\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "New extracted batch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/lote", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "lote" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates the next batch (L1, L2, …) and starts the time out of body. Open session (409). The panel flags the batch «aviso» at the warning threshold and «perigo» at the maximum from Settings.", "body": { "mode": "raw", "raw": "{\n \"quantidade\": 700,\n \"operador_id\": 7\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record an extraction motor reading", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/motor", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "motor" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Session in progress or closed. Values validated by range. «aviso» or «falha» notifies the surgical team. Immutable record (voided with a reason). Returns the updated readings and alerts.", "body": { "mode": "raw", "raw": "{\n \"dados\": {\n \"equipamento_id\": 14,\n \"hora\": \"10:42\",\n \"velocidade_rpm\": 2800,\n \"binario_ncm\": 12.5,\n \"modo\": \"oscilacao\",\n \"punch_mm\": 0.85,\n \"estado\": \"aviso\",\n \"nota\": \"Aquecimento da peça de mão\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Void a motor reading", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/motor_anular", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "motor_anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With a reason (at least 3 characters); the reading keeps the author and reason." } }, { "name": "Import motor readings (CSV)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/motores/importar", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "motores", "importar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "CSV exported by the motor (up to 2 MB, 500 lines, «;» or «,» separator, optional header row). Invalid lines are skipped and counted. Limit: 10 per 10 minutes." } }, { "name": "Pause or resume", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/pausa", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "pausa" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Open session (409). The session and phase timers deduct the paused time. Repeated requests change nothing.", "body": { "mode": "raw", "raw": "{\n \"pausar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patient weight", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/peso", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "peso" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Between 25 and 300 kg (one decimal place). Needed to compute the cumulative lidocaine dose in mg/kg; without weight and with lidocaine recorded, the alert status is «sem_peso». Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"peso_kg\": 80\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Voice counting (audio chunk)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/bloco/painel/:id/voz", "host": [ "{{base_url}}" ], "path": [ "bloco", "painel", ":id", "voz" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "A short audio chunk (WAV PCM 16-bit, 16 kHz, mono, up to ~12 s / 600 KB) captured by the tablet when it detects speech. The server transcribes it with the «contagem_voz» AI use (local service first; the external fallback only with the patient-data switch), interprets the counting words in the given language («one»…«four», «single»…«quadruple», digits, «undo») and records each one as a count with origin «voz» (up to 12 per chunk; room conversation and echoes of the context phrase are ignored). Audio is never stored; «ouvido» is only returned when counts were recorded. Errors: 409 session not open, 503 «voz_indisponivel», 422 format/duration. Transcription failure: 200 with «ok»: false and «erro». Limit: 300 per minute." } } ] }, { "name": "Chat interno", "item": [ { "name": "Channels of the current person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/canais", "host": [ "{{base_url}}" ], "path": [ "chat", "canais" ], "query": [ { "key": "arquivados", "value": "", "disabled": true } ] }, "description": "Only channels the person belongs to (auto-joins their department channels), with unread count, mentions and last message. meta.atualizar_segundos is the refresh interval." } }, { "name": "Create channel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais", "host": [ "{{base_url}}" ], "path": [ "chat", "canais" ] }, "description": "Types: grupo, paciente (requires patient identification access), cirurgia (requires surgery map access) and departamento (chat administrators only). The creator becomes manager.", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"paciente\",\n \"paciente_id\": 41,\n \"membros\": [\n 4,\n 9,\n 12\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Channel with members and read state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/canais/:id", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Archive/reopen channel (manager)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/arquivar", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "arquivar" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"arquivar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark as read up to a message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/lido", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "lido" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ate\": 1204\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add members or an external guest", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/membros", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "membros" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Channel manager (or chat administrator) only. With externo=true the person is limited to THIS channel (422 if already in another).", "body": { "mode": "raw", "raw": "{\n \"membros\": [\n 31\n ],\n \"externo\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove member (or leave)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/membros/:utilizador", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "membros", ":utilizador" ], "variable": [ { "key": "id", "value": "12" }, { "key": "utilizador", "value": "12" } ] }, "description": "" } }, { "name": "Messages (latest, older or new)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/mensagens", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "mensagens" ], "query": [ { "key": "depois", "value": "", "disabled": true }, { "key": "antes", "value": "", "disabled": true }, { "key": "por_pagina", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "No parameters: the latest. «antes=»: older ones (scroll up). «depois=»: new ones plus those changed in the last 2 minutes (refresh). «leituras» gives each member's last read id (read receipts)." } }, { "name": "Send message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/mensagens", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "mensagens" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Text up to the configured limit and/or attachments (ids of files uploaded by the sender through POST /ficheiros with category «chat»). «@Name» mentions channel members, who get a notification without the message text. The body is stored encrypted.", "body": { "mode": "raw", "raw": "{\n \"corpo\": \"@Inês o paciente das 14 h chegou.\",\n \"anexos\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mute/unmute", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/canais/:id/silenciar", "host": [ "{{base_url}}" ], "path": [ "chat", "canais", ":id", "silenciar" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"silenciar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit own message", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/mensagens/:id", "host": [ "{{base_url}}" ], "path": [ "chat", "mensagens", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Within the configured window (15 min by default).", "body": { "mode": "raw", "raw": "{\n \"corpo\": \"O paciente das 14 h já está na sala 2.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete message", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/mensagens/:id", "host": [ "{{base_url}}" ], "path": [ "chat", "mensagens", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Own message or, as channel manager, someone else's. The text is erased; «Message deleted» and the audit entry remain." } }, { "name": "Create task from message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/mensagens/:id/tarefa", "host": [ "{{base_url}}" ], "path": [ "chat", "mensagens", ":id", "tarefa" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "The task gets origin «mensagem», linked to the channel patient/surgery; the channel receives a system message with the link.", "body": { "mode": "raw", "raw": "{\n \"responsavel_id\": 9,\n \"prioridade\": \"alta\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Total unread messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/nao-lidas", "host": [ "{{base_url}}" ], "path": [ "chat", "nao-lidas" ] }, "description": "" } }, { "name": "People to mention or invite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/chat/pessoas", "host": [ "{{base_url}}" ], "path": [ "chat", "pessoas" ], "query": [ { "key": "q", "value": "Inês", "disabled": true }, { "key": "canal", "value": "7", "disabled": true } ] }, "description": "With «canal», only that channel members (mentions). External guests only see their channel." } }, { "name": "Open (or create) a direct conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/chat/privado", "host": [ "{{base_url}}" ], "path": [ "chat", "privado" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"utilizador_id\": 9\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Consultas", "item": [ { "name": "Consultation catalogue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/clinica/catalogo", "host": [ "{{base_url}}" ], "path": [ "clinica", "catalogo" ] }, "description": "In the request language: map zones (polygons in a 100 × 120 box, recipient and donor), scales with grades and loss per zone (Norwood, Ludwig, Savin, Sinclair and BASP), consultation types, areas, techniques, feasibility values, eligibility values, team roles, fields (with help and whether they are doctor-only) and screen sections. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "New consultation (draft)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas", "host": [ "{{base_url}}" ], "path": [ "consultas" ] }, "description": "Requires clinical access to the patient. Episode: the given one (same patient, otherwise 422), the patient active one or a new one. When a booking is already linked to a consultation, that consultation is returned. The history (past history, medication, allergies, habits, family history) is pre-filled from the last signed consultation; the doctor is assigned when a doctor creates it, otherwise the patient doctor. Returns the full screen package. Effects: episode at journey stage 3, timeline, «create» audit; when an episode is opened, episodio.aberto webhook. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"tipo\": \"primeira\",\n \"episodio_id\": 77,\n \"marcacao_id\": 2051\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Full consultation for the screen", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Decrypted consultation, patient (minimal identification), episode, clinical alerts, live eligibility, graft range from the approved clinical table (zone × grade), pending AI proposals, previous consultations, latest pre-consultation questionnaire, permissions on the consultation, AI status for the patient and the prescription link (doctors only). Requires ficha.clinica ≥ view (or emergency access) and the patient in clinical scope. Read is audited («ver», consultas). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Save draft fields", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Screen autosave: only the fields sent change (closed list; others are ignored). Drafts only and with «edit» on ficha.clinica (signed consultation → 403; corrections go through addenda). Doctors and nurses record the history; diagnosis, differential diagnosis, scale, grade, BASP, PRECISE, scales, map, area, technique and sessions are doctor-only (sent by another profile → 422 on that field). Clinical texts up to 20,000 characters, encrypted at rest; scale and grade must be consistent. Recalculates and stores eligibility with the final values. Effects: «alterar» audit with the field list. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"alergias\": \"Penicilina.\",\n \"medicacao\": \"Apixabano 5 mg.\",\n \"escala\": \"norwood\",\n \"grau\": \"IV\",\n \"zonas\": {\n \"zonas\": [\n \"linha_frontal\",\n \"frontal\",\n \"coroa\"\n ],\n \"pontos\": [\n {\n \"x\": 0.5,\n \"y\": 0.71,\n \"nota\": \"Miniaturização visível\"\n }\n ],\n \"linha\": [\n {\n \"x\": 0.3,\n \"y\": 0.14\n },\n {\n \"x\": 0.5,\n \"y\": 0.11\n },\n {\n \"x\": 0.7,\n \"y\": 0.14\n }\n ]\n },\n \"tecnica\": \"FUE\",\n \"sessoes_previstas\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Correction by addendum", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/aditamentos", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "aditamentos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Signed consultations only (otherwise 403). Appends, never rewrites: text of 1 to 5000 characters, encrypted, with author and date. Returns every addendum in chronological order. Effects: timeline, «alterar» audit. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"texto\": \"Onde se lê «coroa», deve ler-se «zona média».\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sign the consultation (doctors)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/assinar", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "assinar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires confirmar = true, a draft consultation, a doctor with «edit» on ficha.clinica and the consultation without a doctor, of the same doctor or with «all» scope (otherwise 403). Refuses (422) without examination or diagnosis. Stores the SHA-256 fingerprint of the canonical serialisation of the content (fields, signing time and doctor) and, if sent, the drawn signature (PNG data URL, up to 2 MB) as a private clinical file. Once signed nothing is rewritten: only addenda. Effects: timeline, «assinar» audit, consulta.assinada webhook. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"confirmar\": true,\n \"assinatura\": \"data:image/png;base64,iVBORw0KGgo…\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Completeness check before surgery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id/completude", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "completude" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "What is done and what is missing in the episode: signed consultation, clinical notes, validated feasibility, validated pre-consultation questionnaire, validated alerts, photos, approved plan, surgical consent, accepted proposal and paid deposit. Each item: ok, falta or indisponivel (module absent), with the web and app link to resolve it. Statuses only — never commercial values nor other modules content. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Evaluate eligibility with unsaved values", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/elegibilidade", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "elegibilidade" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Merges the posted values (only those used by the rules, up to 20,000 characters each) into the saved consultation and evaluates the clinic approved eligibility rules and the approved engine version limits (minimum age, alert age, maximum miniaturisation). Nothing is saved. Status: por_avaliar (no rules nor engine), nao_apto (any block), apto_condicional (any alert) or apto. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"medicacao\": \"Apixabano 5 mg\",\n \"miniaturizacao_dadora_pct\": 12,\n \"escala\": \"norwood\",\n \"grau\": \"IV\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Scribe: proposals from the transcript", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/escriba", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "escriba" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft consultations only. The consultation text (pasted or dictated, 20 to 40,000 characters) or a transcript file (.txt, .vtt or .srt, text, up to 1 MB; subtitle numbering and timings removed) is read and discarded — never stored. The assistant proposes each field (reason, history, examination, diagnosis, scale, grade, miniaturisation, notes) with the exact excerpt it comes from and the confidence; the server checks that the excerpt really is in the transcript (fatores.excerto_verificado). Proposals and excerpts are stored encrypted. Uses the clinic's AI assistant: requires a valid «ia» consent from the patient and the use to be configured (otherwise 422). The result is never a decision — each value becomes a pending proposal (ia_propostas) recording the model used, the request parameters and the explanatory factors, until a doctor accepts, corrects or refuses it. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Effects: pending proposals, «create» audit on ia_propostas. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 30 requests per 10 minutes per IP address (only data-changing requests count).", "body": { "mode": "raw", "raw": "{\n \"texto\": \"Médica: o que o traz cá? Paciente: estou a perder cabelo à frente há uns cinco anos… sou alérgico à penicilina, fiquei cheio de manchas.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Dictation scribe: transcribe one part of the consultation audio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id/escriba/audio", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "escriba", "audio" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft consultations and doctors only. One part of the audio (16 kHz mono WAV of ~45 s sent by the web and the app; also MP3, OGG, FLAC, WEBM or M4A, up to 4 MB and 2 minutes). Each part checks the patient «gravacao_video» (consultation recording) and «ia» consents — without them, 422 with code «consentimento_em_falta». The audio is transcribed («escriba» use, transcription type: local service first; external only with the patient-data switch) and discarded: it is never stored. The transcript is returned and not stored. Uses the clinic's AI assistant: requires a valid «ia» consent from the patient and the use to be configured (otherwise 422). The result is never a decision — each value becomes a pending proposal (ia_propostas) recording the model used, the request parameters and the explanatory factors, until a doctor accepts, corrects or refuses it. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Effects: «create» audit on consultas with metrics only (part, seconds, bytes, service, characters). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 240 requests per 10 minutes per IP address (only data-changing requests count)." } }, { "name": "Read the transcript saved by the doctor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id/escriba/transcricao", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "escriba", "transcricao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Decrypted text (audited read) and metadata; null text when there is none. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403." } }, { "name": "Save the transcript in the consultation (encrypted)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id/escriba/transcricao", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "escriba", "transcricao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft consultations only. 20 to 40,000 characters, stored encrypted with the clinical key (replaces the previous one). Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403." } }, { "name": "Discard the saved transcript", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/consultas/:id/escriba/transcricao/apagar", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "escriba", "transcricao", "apagar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Deletes the encrypted text and metadata; the audit records the act (without the text). Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403." } }, { "name": "Photo pre-analysis", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/pre-analise", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "pre-analise" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Up to 6 photos: those in ficheiro_ids (only images of the patient, or without owner, from the current clinic), or the most recent ones in the patient gallery (no simulations nor rejected), or those of the latest pre-assessment; no photos → 422. The assistant proposes scale and grade, a graft range (as a notes proposal) and the donor area status (examination proposal), following the approved engine clinical table when available; justification, observations and photos used are kept in the factors. Uses the clinic's AI assistant: requires a valid «ia» consent from the patient and the use to be configured (otherwise 422). The result is never a decision — each value becomes a pending proposal (ia_propostas) recording the model used, the request parameters and the explanatory factors, until a doctor accepts, corrects or refuses it. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Effects: pending proposals, «create» audit on ia_propostas. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 20 requests per 10 minutes per IP address (only data-changing requests count).", "body": { "mode": "raw", "raw": "{\n \"ficheiro_ids\": [\n 8812,\n 8813,\n 8814\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Validate feasibility (doctors)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/consultas/:id/viabilidade", "host": [ "{{base_url}}" ], "path": [ "consultas", ":id", "viabilidade" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records the decision, who decided and when. The note goes into the notes (draft) or as an addendum (signed). With the episode in «avaliacao»: «viavel» moves it to «plano» (stage 4) and «nao_viavel» closes it as «cancelado»; «condicional» keeps it. Returns the consultation and the episode in the M1Episodio shape (no clinical content, with the active team), or null without an episode. Effects: timeline, «aprovar» audit; on a status change, automatic tasks for the status and episodio.estado_alterado webhook. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"viavel\",\n \"nota\": \"Dadora suficiente para uma sessão.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Accept, correct or refuse an AI proposal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ia-propostas/:id/decisao", "host": [ "{{base_url}}" ], "path": [ "ia-propostas", ":id", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires «edit» on ficha.clinica and the patient in clinical scope; triage proposals may also be decided by nurses, the others only by doctors (403). Pending proposals only (already decided → 422). «aceite» uses the proposed value, «corrigida» requires valor_final, «recusada» accepts a reason (cut at 400 characters). On a draft consultation the value goes into the field (texts appended to what was there; scale, grade, BASP and miniaturisation replaced); on a signed consultation only the decision is kept (use an addendum). Effects: «aprovar» audit with type, field and model; when applied, the consultation save and its audit. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"corrigida\",\n \"valor_final\": \"Alergia a penicilina (urticária em 2019).\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Sessão", "item": [ { "name": "Clinics available in the switcher", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/clinicas", "host": [ "{{base_url}}" ], "path": [ "clinicas" ] }, "description": "" } }, { "name": "Request emergency access to a patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/emergencia", "host": [ "{{base_url}}" ], "path": [ "emergencia" ] }, "description": "When a request returns 403 with erro.paciente_id, the app may offer this request. Reason required (20 to 1000 characters). Access is temporary (Settings › Security), logged in the audit trail and reviewed by management. Profiles whose data-protection ceiling forbids clinical access cannot request it." } }, { "name": "Who am I (account, clinic, effective permissions, preferences)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/eu", "host": [ "{{base_url}}" ], "path": [ "eu" ] }, "description": "Team: account, global, clinics, permissions (module → {nivel, ambito, aprovar, exportar}), active modules, emergencies, preferences. Patient: account and preferences. Integration: client and scope permissions." } }, { "name": "Switch clinic (global users only)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/eu/clinica", "host": [ "{{base_url}}" ], "path": [ "eu", "clinica" ] }, "description": "The choice is bound to the app session; alternatively send X-AX-Clinica on each request." } }, { "name": "Menu filtered by permissions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/menu", "host": [ "{{base_url}}" ], "path": [ "menu" ] }, "description": "List of groups {chave, titulo, icone, itens}. Each item: {chave, titulo, icone, url, web, rota, tipo: recurso|ecra, recurso?, app?, contador, ajuda, ativo}." } }, { "name": "Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/notificacoes", "host": [ "{{base_url}}" ], "path": [ "notificacoes" ], "query": [ { "key": "por_ler", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Mark all as read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/notificacoes/lidas", "host": [ "{{base_url}}" ], "path": [ "notificacoes", "lidas" ] }, "description": "" } }, { "name": "Mark as read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/notificacoes/:id/lida", "host": [ "{{base_url}}" ], "path": [ "notificacoes", ":id", "lida" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Global search", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/procurar", "host": [ "{{base_url}}" ], "path": [ "procurar" ], "query": [ { "key": "q", "value": "", "disabled": false } ] }, "description": "Patients, leads, records and screens the profile can see. Never returns clinical content to profiles without access." } } ] }, { "name": "Caixa", "item": [ { "name": "Till for a day", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/caixa", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa" ], "query": [ { "key": "data", "value": "", "disabled": true }, { "key": "local_id", "value": "", "disabled": true } ] }, "description": "Till for the day (or null if not opened), expected totals per method, movements and recorded payments." } }, { "name": "Open today's till", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/caixa", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"saldo_inicial\": 150\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Till history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/caixa/historico", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa", "historico" ], "query": [ { "key": "limite", "value": "", "disabled": true }, { "key": "local_id", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Close till", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/caixa/:id/fecho", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa", ":id", "fecho" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Count per method (every method with movements is mandatory). Stores counted amount and difference; difference ≠ 0 notifies administration. A closed till does not reopen.", "body": { "mode": "raw", "raw": "{\n \"contagem\": {\n \"numerario\": 412.5,\n \"cartao\": 1380\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cash-in or withdrawal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/caixa/:id/movimentos", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa", ":id", "movimentos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Record in-person payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/caixa/:id/pagamentos", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa", ":id", "pagamentos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Receives a pending plan payment (pagamento_id) or creates an ad-hoc one (paciente_id, tipo, descricao, valor). In-person methods from Settings. Effects: payment paid in the till, tax document (automatic issue), commissions, pagamento.recebido event.", "body": { "mode": "raw", "raw": "{\n \"pagamento_id\": 204,\n \"metodo\": \"cartao\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Active clinic locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/locais", "host": [ "{{base_url}}" ], "path": [ "comercial", "locais" ] }, "description": "" } } ] }, { "name": "Terminais de pagamento", "item": [ { "name": "Reconcile terminals with the till", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/caixa/:id/reconciliacao", "host": [ "{{base_url}}" ], "path": [ "comercial", "caixa", ":id", "reconciliacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Send a pending payment to the terminal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/terminal", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "terminal" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires the location's till to be open (setting terminais.exigir_caixa). Returns the request; check its status at /comercial/terminais/pedidos/{id}." } }, { "name": "Terminals ready to charge", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/terminais", "host": [ "{{base_url}}" ], "path": [ "comercial", "terminais" ], "query": [ { "key": "local_id", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "New charge at the desk", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/terminais/cobrancas", "host": [ "{{base_url}}" ], "path": [ "comercial", "terminais", "cobrancas" ] }, "description": "" } }, { "name": "Live status of a charge", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/terminais/pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "comercial", "terminais", "pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "While «enviado», queries the provider (at most every 3 s)." } }, { "name": "Cancel the charge on the terminal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/terminais/pedidos/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "comercial", "terminais", "pedidos", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Carteira", "item": [ { "name": "Patient wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/carteira", "host": [ "{{base_url}}" ], "path": [ "comercial", "carteira" ], "query": [ { "key": "paciente_id", "value": "", "disabled": false }, { "key": "limite", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Grant credit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/carteira/credito", "host": [ "{{base_url}}" ], "path": [ "comercial", "carteira", "credito" ] }, "description": "Credit without money received: used in payments, never refunded. Reason required.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 12,\n \"valor\": 50,\n \"motivo\": \"Compensação pela sessão remarcada\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/carteira/devolucao", "host": [ "{{base_url}}" ], "path": [ "comercial", "carteira", "devolucao" ] }, "description": "Up to the refundable balance. Cash leaves the location's open till. Issues credit notes on the advance invoices." } }, { "name": "Reverse a credit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/carteira/movimentos/:id/estorno", "host": [ "{{base_url}}" ], "path": [ "comercial", "carteira", "movimentos", ":id", "estorno" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Pay with the wallet balance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/carteira", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "carteira" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Without amount = the maximum possible. If the balance is not enough, the payment is split (part with balance + remainder due). No new invoice." } } ] }, { "name": "Comissões e honorários", "item": [ { "name": "Commissions and fees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/comissoes", "host": [ "{{base_url}}" ], "path": [ "comercial", "comissoes" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "tipo", "value": "", "disabled": true }, { "key": "estado", "value": "", "disabled": true }, { "key": "utilizador_id", "value": "", "disabled": true } ] }, "description": "Indicators, lines, per-person summary and monthly paid series. Without financeiro.valores (edit), only own values." } }, { "name": "Mark as paid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/comissoes/pagar", "host": [ "{{base_url}}" ], "path": [ "comercial", "comissoes", "pagar" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"comissoes\": [\n 301,\n 302\n ],\n \"honorarios\": [\n 77\n ],\n \"referencia\": \"TRF 2026-11-30\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contas pagadoras e convenções", "item": [ { "name": "Paying-account statement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/contas/:id", "host": [ "{{base_url}}" ], "path": [ "comercial", "contas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Simulate the payer/patient split", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/reparticao", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", "reparticao" ], "query": [ { "key": "paciente_id", "value": "", "disabled": false }, { "key": "conta_id", "value": "", "disabled": true }, { "key": "convencao_id", "value": "", "disabled": true }, { "key": "procedimento_id", "value": "", "disabled": true }, { "key": "valor", "value": "", "disabled": true }, { "key": "quantidade", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Create the payer and patient shares", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/repartidos", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", "repartidos" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 12,\n \"convencao_id\": 3,\n \"procedimento_id\": 9,\n \"tipo\": \"tratamento\",\n \"metodo\": \"numerario\",\n \"pago\": true,\n \"autorizacao\": \"A-55120\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Pagamentos", "item": [ { "name": "Document e-invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/documentos/:id/eletronica", "host": [ "{{base_url}}" ], "path": [ "comercial", "documentos", ":id", "eletronica" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Status and what the connected invoicing software does through the integration (today none produces CIUS-PT nor signs the PDF)." } }, { "name": "Record the delivered e-invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/documentos/:id/eletronica", "host": [ "{{base_url}}" ], "path": [ "comercial", "documentos", ":id", "eletronica" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Delivery reference and/or the PDF with qualified signature (ficheiro_id from POST /ficheiros, PDF only)." } }, { "name": "Email to the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/documentos/:id/enviar", "host": [ "{{base_url}}" ], "path": [ "comercial", "documentos", ":id", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Issue credit note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/documentos/:id/nota-credito", "host": [ "{{base_url}}" ], "path": [ "comercial", "documentos", ":id", "nota-credito" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Reembolso parcial acordado\",\n \"valor\": 200\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Tax document PDF", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/documentos/:id/pdf", "host": [ "{{base_url}}" ], "path": [ "comercial", "documentos", ":id", "pdf" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Payment plan of the patient or episode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos" ], "query": [ { "key": "paciente_id", "value": "", "disabled": true }, { "key": "episodio_id", "value": "", "disabled": true } ] }, "description": "Payments, totals (accepted, paid, due, overdue), tax documents, available methods and allowed actions." } }, { "name": "Create payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos" ] }, "description": "Pagamentos::criar — with an electronic method it immediately requests the clinic's provider (MB WAY requires a phone and honours the limit); with an in-person method and pago=true it requires the till open.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 12,\n \"tipo\": \"consulta\",\n \"descricao\": \"Consulta de avaliação\",\n \"valor\": 80,\n \"metodo\": \"mbway\",\n \"telefone\": \"912345678\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create or adjust the plan of an accepted proposal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/plano", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", "plano" ] }, "description": "" } }, { "name": "Outstanding balances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/saldos", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", "saldos" ], "query": [ { "key": "limite", "value": "", "disabled": true }, { "key": "local_id", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Cancel unpaid payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Check status with the provider", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/estado", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "For pending electronic payments asks the provider and applies the result (paid → «api» confirmation). Used by the live MB WAY status." } }, { "name": "Issue tax document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/fatura", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "fatura" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Faturacao::emitir (idempotent) through the clinic's certified software. Software error → document «erro» with the reason and automatic retry." } }, { "name": "Generate MB WAY, reference or link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/gerar", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "gerar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"metodo\": \"multibanco\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark as paid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/marcar-pago", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "marcar-pago" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Cash and card require today's till open. Same effects as a confirmed payment.", "body": { "mode": "raw", "raw": "{\n \"metodo\": \"transferencia\",\n \"notas\": \"Transferência confirmada no extrato\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund paid payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/reembolsar", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "reembolsar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Effects: credit note for the document (when it exists), reversal of the proposal's commissions, audit. The money is returned outside the platform." } } ] }, { "name": "Vales de oferta", "item": [ { "name": "Pay with a voucher", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/pagamentos/:id/vale", "host": [ "{{base_url}}" ], "path": [ "comercial", "pagamentos", ":id", "vale" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Sell a voucher", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/vales", "host": [ "{{base_url}}" ], "path": [ "comercial", "vales" ] }, "description": "Creates the voucher (unpaid) and the sale payment. The voucher becomes active when the payment is received. The full code is only returned to those who edit payments.", "body": { "mode": "raw", "raw": "{\n \"valor\": 100,\n \"finalidade\": \"multipla\",\n \"beneficiario_nome\": \"Ana\",\n \"metodo\": \"numerario\",\n \"pago\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Look up a voucher by code", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/vales/consulta", "host": [ "{{base_url}}" ], "path": [ "comercial", "vales", "consulta" ], "query": [ { "key": "codigo", "value": "", "disabled": false } ] }, "description": "" } } ] }, { "name": "Propostas", "item": [ { "name": "Simulate price", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/precos/simular", "host": [ "{{base_url}}" ], "path": [ "comercial", "precos", "simular" ], "query": [ { "key": "procedimento_id", "value": "", "disabled": true }, { "key": "tabela_id", "value": "", "disabled": true }, { "key": "enxertos", "value": "", "disabled": true }, { "key": "sessoes", "value": "", "disabled": true }, { "key": "quantidade", "value": "", "disabled": true }, { "key": "desconto_pct", "value": "", "disabled": true }, { "key": "desconto_valor", "value": "", "disabled": true }, { "key": "moeda", "value": "", "disabled": true } ] }, "description": "Precos::calcular without saving: base, extras, discount, VAT, total, total in the requested currency and average price per graft." } }, { "name": "Proposals dashboard and list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas" ], "query": [ { "key": "estado", "value": "", "disabled": true }, { "key": "responsavel_id", "value": "", "disabled": true }, { "key": "paciente_id", "value": "", "disabled": true }, { "key": "q", "value": "", "disabled": true }, { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true } ] }, "description": "Indicators (drafts, with the patient, open value, viewed, accepted this month, 90-day acceptance rate, stalled, discounts pending), filtered paginated list, monthly chart (sent and accepted series) and funnel. Honours scope (own/team/all)." } }, { "name": "Create proposal (from plan or manual)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas" ] }, "description": "With plano_id: Propostas::criarDoPlano — requires the approved plan; options from the plan scenarios or by intensity (Settings), with a plan snapshot and parameters version. Without plano_id: manual proposal with paciente_id or lead_id and procedimento_id. Effects: numbering, history, timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"plano_id\": 44\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Patient's approved plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/planos", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", "planos" ], "query": [ { "key": "paciente_id", "value": "", "disabled": false } ] }, "description": "Summary of approved plans (version, technique, grafts, sessions, approval date) to create the proposal. Empty list without the planning module." } }, { "name": "Proposal detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Everything the editor shows: options with calculation, lines, available extras, discount and profile limit, instalments (deposit and simulation), currency and rate, seal, public link (edit only), PDFs, history, allowed actions and, with financeiro.pagamentos, the payments. margem and custos_internos only with financeiro.valores (all)." } }, { "name": "Save and recalculate (draft)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft only. The server always recalculates (Precos::calcular). A discount above the profile limit becomes «pending» and notifies approvers. opcao_nova adds an option; opcao_remover removes the option with that key.", "body": { "mode": "raw", "raw": "{\n \"opcoes\": [\n {\n \"chave\": \"recomendada\",\n \"titulo\": \"Recomendada\",\n \"enxertos\": 2800,\n \"sessoes\": 1,\n \"quantidade\": 1,\n \"recomendada\": true\n }\n ],\n \"desconto_pct\": 5,\n \"desconto_motivo\": \"Campanha de outono\",\n \"prestacoes\": 6\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "In-person acceptance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/aceitar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "aceitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Patient signature on the device (PNG data URL). Verifies the seal; stores the proof (accepted text, option, name, signature, IP, device, fingerprint); creates the payment plan and expected commissions; proposta.aceite event.", "body": { "mode": "raw", "raw": "{\n \"opcao\": \"recomendada\",\n \"nome\": \"Ricardo Matos\",\n \"assinatura\": \"data:image/png;base64,iVBORw0KGgo…\",\n \"prestacoes\": 1,\n \"aceitar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel acceptance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/anular", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Accepted proposal: cancels unpaid payments, reverses commissions and returns to «recusada», with the reason. Paid payments are handled by refund." } }, { "name": "Apply a discount code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/codigo", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "codigo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft only. The code's discount replaces the manual discount; above the code's approval threshold it becomes «pendente».", "body": { "mode": "raw", "raw": "{\n \"codigo\": \"PRIMAVERA10\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove the discount code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/codigo/retirar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "codigo", "retirar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Apply or request discount", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/desconto", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "desconto" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Within the profile limit it is applied; above it, it stays pending and notifies those with comercial.descontos (approve).", "body": { "mode": "raw", "raw": "{\n \"desconto_pct\": 12,\n \"desconto_motivo\": \"Segunda sessão no mesmo ano\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve or decline discount", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/desconto/decisao", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "desconto", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"aprovar\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send to patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/enviar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires a sealed proposal. Generates (or reuses) the personal link, generates the PDFs and sends through the requested channels with the Messenger. First sending → status «enviada», timeline and proposta.enviada event.", "body": { "mode": "raw", "raw": "{\n \"canais\": [\n \"email\",\n \"whatsapp\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Proposal PDF", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/pdf", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "pdf" ], "query": [ { "key": "idioma", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Reactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/reativar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "A declined or expired proposal goes back to draft, with a new validity and recalculated with the current price table." } }, { "name": "Record decline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/recusar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "recusar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Effects: status «recusada», history, timeline, proposta.recusada event." } }, { "name": "New version for revision", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/rever", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "rever" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "A sent or viewed proposal goes back to draft with version + 1 and no seal; the previous link stops accepting responses." } }, { "name": "Seal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comercial/propostas/:id/selar", "host": [ "{{base_url}}" ], "path": [ "comercial", "propostas", ":id", "selar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Recalculates, requires total > 0 and no pending discount, and stores the SHA-256 fingerprint of the canonical content (options, lines, values, terms, plan snapshot)." } } ] }, { "name": "Comunicados", "item": [ { "name": "Notices addressed to the person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comunicados", "host": [ "{{base_url}}" ], "path": [ "comunicados" ], "query": [ { "key": "filtro", "value": "", "disabled": true }, { "key": "q", "value": "", "disabled": true } ] }, "description": "Published, in force and addressed to everyone, the department or the caller's role (managers see all). Create and edit: generic resource /r/comunicados." } }, { "name": "Read notice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comunicados/:id", "host": [ "{{base_url}}" ], "path": [ "comunicados", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Who read and who has not (managers)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comunicados/:id/leituras", "host": [ "{{base_url}}" ], "path": [ "comunicados", ":id", "leituras" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Remind those who have not read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comunicados/:id/lembrar", "host": [ "{{base_url}}" ], "path": [ "comunicados", ":id", "lembrar" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Confirm reading", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/comunicados/:id/ler", "host": [ "{{base_url}}" ], "path": [ "comunicados", ":id", "ler" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Idempotent. Stores who, when and from where (web/app) and writes the audit log." } } ] }, { "name": "Documentos", "item": [ { "name": "Mobile Digital Key service status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/assinatura-qualificada", "host": [ "{{base_url}}" ], "path": [ "conformidade", "assinatura-qualificada" ] }, "description": "Tells whether Mobile Digital Key signing is available and, if not, what is missing (AMA agreement/credentials in Settings, server modules, PDF generator). Without credentials, requests are refused and nothing is sent." } }, { "name": "Issue a document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos" ] }, "description": "Assigns a number, a verification code and a fingerprint; content is encrypted; the PDF is generated when the generator is installed. Missing mandatory extra fields → 422 (campos.{key}).", "body": { "mode": "raw", "raw": "{\n \"modelo_id\": 3,\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"partilhar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approved templates and available fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/modelos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", "modelos" ] }, "description": "Approved templates with the extra fields requested when issuing; meta.campos_disponiveis lists the automatic fields ({{group.field}} → label)." } }, { "name": "Preview a document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/pre-visualizar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", "pre-visualizar" ] }, "description": "Sanitised HTML with the fields replaced and the list of fields without data. Stores nothing. Clinical templates require clinical access to the patient.", "body": { "mode": "raw", "raw": "{\n \"modelo_id\": 3,\n \"paciente_id\": 1204,\n \"campos\": {\n \"observacoes\": \"Evitar exposição solar 15 dias.\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Document with certificate and timeline", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Content is only included when pode_ver_conteudo (clinical documents: clinical access to the patient)." } }, { "name": "Cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/anular", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The document stays in the archive; public verification shows it as cancelled.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Emitido com o episódio errado.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sign on screen (in person)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/assinar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "assinar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Holder signature (and physician signature when the template asks). Generates the certificate." } }, { "name": "Qualified signature requests of the document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/cmd", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "cmd" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Request the Mobile Digital Key signature", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/cmd", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "cmd" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The holder gives the mobile number and PIN. The platform obtains the certificate chain, prepares the PDF for PAdES, computes the signed-attributes digest and requests the signature from the AMA service, which texts a code to the holder. The PIN is never stored or returned. Reflection period applies. Limit: 10 per 10 minutes.", "body": { "mode": "raw", "raw": "{\n \"telemovel\": \"+351 912345678\",\n \"pin\": \"••••\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel the request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/cmd/:pedido/cancelar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "cmd", ":pedido", "cancelar" ], "variable": [ { "key": "id", "value": "1" }, { "key": "pedido", "value": "1" } ] }, "description": "" } }, { "name": "Confirm the code and complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/cmd/:pedido/codigo", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "cmd", ":pedido", "codigo" ], "variable": [ { "key": "id", "value": "1" }, { "key": "pedido", "value": "1" } ] }, "description": "Validates the code with the service, checks the signature against the certificate, writes the CMS container into the PDF (PAdES, ETSI.CAdES.detached), validates the result and stores it as the document signature, with the completion certificate and linked consent. Up to 3 attempts per request.", "body": { "mode": "raw", "raw": "{\n \"codigo\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend the code by text message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/cmd/:pedido/sms", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "cmd", ":pedido", "sms" ], "variable": [ { "key": "id", "value": "1" }, { "key": "pedido", "value": "1" } ] }, "description": "The mobile number must match the request (compared by blind index). Limit: 5 per 10 minutes.", "body": { "mode": "raw", "raw": "{\n \"telemovel\": \"+351 912345678\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send for signature with a code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/enviar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates a new link (the previous one stops working) and a 6-digit code sent in a separate message. Validity and attempts in Settings.", "body": { "mode": "raw", "raw": "{\n \"canal\": \"email\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Share in or remove from the portal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/partilhar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"partilhar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Document PDF", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/pdf", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "pdf" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With a stored PDF: {tipo: \"pdf\", url (15 min)}. Without: {tipo: \"html\", html, url_web} to display or print." } }, { "name": "Attach a PDF with a qualified signature", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/documentos/:id/qualificada", "host": [ "{{base_url}}" ], "path": [ "conformidade", "documentos", ":id", "qualificada" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "ficheiro_id of a PDF already uploaded with POST /ficheiros. The file must contain a digital signature, which is validated: structure, content integrity (digest of the covered ranges), mathematical signature against the included certificate, certificate validity at the declared time, qualified-certificate statement and consistency of the included chain. A PDF changed after signing or with a signature that does not match is refused (422). The result is stored in certificado.validacao, with the list of what is not validated here (root trust, revocation, timestamps).", "body": { "mode": "raw", "raw": "{\n \"ficheiro_id\": 7781\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Public document verification", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/verificar/:codigo", "host": [ "{{base_url}}" ], "path": [ "conformidade", "verificar", ":codigo" ], "variable": [ { "key": "codigo", "value": "K7QM-3XRA" } ] }, "description": "No authentication and no clinical data: status, number, type, dates, entity, physician, holder initials and fingerprints of the content and the PDF. Rate-limited per address.", "auth": { "type": "noauth" } } } ] }, { "name": "Proteção de dados", "item": [ { "name": "Notices in force per channel and displays", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/avisos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "avisos" ], "query": [ { "key": "dias", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Data protection officer dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/dpo", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo" ] }, "description": "The same data as the web screen: kpis (with web and app links), requests, complaints, incidents (seconds until the CNPD deadline), alerts (empty without admin.auditoria), processors, rat, training, ers, review (null without admin.utilizadores), consents (chart per purpose and decision, per day, withdrawals in 30 days), equipment, templates to approve, retention and officer; permissoes tells which actions are available. No clinical data." } }, { "name": "Detect anomalous access now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/alertas/detetar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "alertas", "detetar" ] }, "description": "Analyses the last 24 h of the activity log. criados: number of new alerts per type." } }, { "name": "Review an alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/alertas/:id/rever", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "alertas", ":id", "rever" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "«injustificado» creates a task for administration. An alert about one’s own access cannot be reviewed by that person.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"justificado\",\n \"notas\": \"Consulta de rotina do dia.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm the ERS register update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/ers/:id", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "ers", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Start the access review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/revisao", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "revisao" ] }, "description": "Stores the snapshot of effective permissions (or returns the review in progress)." } }, { "name": "Review with the snapshot", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/revisao/:id", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "revisao", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Complete the review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/dpo/revisao/:id/concluir", "host": [ "{{base_url}}" ], "path": [ "conformidade", "dpo", "revisao", ":id", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"notas\": \"Acessos conferidos com a direção.\",\n \"alteracoes\": \"Desativada a conta de um técnico sem uso.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Who accessed the patient data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/pacientes/:id/acessos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "pacientes", ":id", "acessos" ], "query": [ { "key": "f[acao]", "value": "", "disabled": true }, { "key": "f[ator]", "value": "", "disabled": true }, { "key": "f[perfil]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[de]", "value": "", "disabled": true }, { "key": "f[ate]", "value": "", "disabled": true }, { "key": "f[emergencia]", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Permission: admin.auditoria (view) or conformidade (edit). Up to the 1000 most recent records, filtered; summary, per day, people and per action. The request is logged." } }, { "name": "Export complaints for the ERS (CSV)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/reclamacoes/exportar-ers", "host": [ "{{base_url}}" ], "path": [ "conformidade", "reclamacoes", "exportar-ers" ], "query": [ { "key": "de", "value": "", "disabled": false }, { "key": "ate", "value": "", "disabled": false } ] }, "description": "Requires export permission. CSV with «;», UTF-8 with BOM: number, Book reference, type, channel, category, dates, status and working days to reply. Marks the rows as exported." } }, { "name": "Export a data subject’s data (ZIP)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/titulares/:id/exportacao", "host": [ "{{base_url}}" ], "path": [ "conformidade", "titulares", ":id", "exportacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "For access and portability requests: dados.json, summary (PDF or HTML), shareable documents and images. Clinical records are only included for callers with clinical access to the patient. Without the ZIP extension on the server, returns dados.json." } } ] }, { "name": "Consentimentos", "item": [ { "name": "Proof of a consent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/consentimentos/:id/prova", "host": [ "{{base_url}}" ], "path": [ "conformidade", "consentimentos", ":id", "prova" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Exact text of the accepted version, integrity check (texto_integro), decision, channel, dates, who collected, device, IP, fingerprints, delivery and temporary links (15 min) to the signature images. The request is logged as an export." } }, { "name": "Privacy notices shown to the patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/pacientes/:id/avisos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "pacientes", ":id", "avisos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Versions shown per channel (including those shown while a sales contact), with text and row integrity checks." } }, { "name": "Current state per purpose", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/pacientes/:id/consentimentos", "host": [ "{{base_url}}" ], "path": [ "conformidade", "pacientes", ":id", "consentimentos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Latest decision of each purpose for the patient." } }, { "name": "Collection data for a patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/conformidade/recolha", "host": [ "{{base_url}}" ], "path": [ "conformidade", "recolha" ], "query": [ { "key": "paciente_id", "value": "", "disabled": false }, { "key": "episodio_id", "value": "", "disabled": true } ] }, "description": "Patient, chosen episode and the patient episodes, privacy notice in force (channel «app», falling back to «portal») with the date it was shown, approved applicable templates in the patient language with the current state of each purpose, the delivery in progress (with seconds until the end of the reflection period) and, for surgical ones with an episode, validity and reasons; physicians who can sign. No side effects." } }, { "name": "Record that the privacy notice was shown", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/recolha/aviso", "host": [ "{{base_url}}" ], "path": [ "conformidade", "recolha", "aviso" ] }, "description": "Stores which notice version was shown to the patient and when.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"aviso_id\": 6\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deliver the information of a template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/recolha/entregar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "recolha", "entregar" ] }, "description": "Records the delivery of the information (full text and version) and starts the template reflection period. By default the information is also stored as a document in the patient portal (copia_portal).", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"modelo_id\": 14,\n \"episodio_id\": 77\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send for signature at home", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/recolha/enviar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "recolha", "enviar" ] }, "description": "Delivers the information, creates the document and sends the patient the personal link (email, SMS or WhatsApp) with the one-time code in a separate message. The reflection period applies to the link.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"modelo_id\": 14,\n \"canal\": \"email\",\n \"episodio_id\": 77\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record decisions and signatures", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/conformidade/recolha/registar", "host": [ "{{base_url}}" ], "path": [ "conformidade", "recolha", "registar" ] }, "description": "Each template must carry an explicit decision («dado» or «recusado»). Given written consents require the patient signature; the surgical one requires an episode, a recorded delivery, the end of the reflection period and the physician signature (medico_id + assinatura_medico). contra_assinar adds the physician signature to surgical consents signed at home. Field validation errors: decisoes.N, modelo_{id}, assinatura_paciente, assinatura_medico, episodio_id, medico_id.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"medico_id\": 7,\n \"assinatura_paciente\": \"data:image/png;base64,iVBORw0…\",\n \"assinatura_medico\": \"data:image/png;base64,iVBORw0…\",\n \"decisoes\": [\n {\n \"modelo_id\": 14,\n \"decisao\": \"dado\"\n },\n {\n \"modelo_id\": 9,\n \"decisao\": \"recusado\",\n \"motivo\": \"Prefere não receber comunicações\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Privacy notice in force for a form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/avisos/:contexto", "host": [ "{{base_url}}" ], "path": [ "publico", "avisos", ":contexto" ], "query": [ { "key": "lingua", "value": "", "disabled": true } ], "variable": [ { "key": "contexto", "value": "1" } ] }, "description": "No session. Returns the versioned notice of the context channel (or null) and the token of the version shown; send it as «aviso_testemunho» with the form to record the display. «demonstracao» always belongs to the main clinic. Limit: 60 per minute.", "auth": { "type": "noauth" } } } ] }, { "name": "Agente de IA", "item": [ { "name": "Agent requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente", "host": [ "{{base_url}}" ], "path": [ "crm", "agente" ], "query": [ { "key": "estado", "value": "", "disabled": true }, { "key": "tipo", "value": "", "disabled": true }, { "key": "canal", "value": "", "disabled": true }, { "key": "alarme", "value": "", "disabled": true }, { "key": "amostra", "value": "", "disabled": true }, { "key": "todos", "value": "", "disabled": true } ] }, "description": "Requests handled by the voice agent and the written assistants. Open ones by default; todos=1 includes resolved ones. meta has the counts per status, this month's usage and whether the assistant is configured." } }, { "name": "Agent outbound calls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/saida", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "saida" ] }, "description": "Dialler lists called by the voice agent: progress, calls in progress, window and whether it can call now (with the reason when it cannot)." } }, { "name": "Agent tests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes" ] }, "description": "Test conversations, unpublished knowledge base drafts, current rules, latest runs and whether tests are mandatory." } }, { "name": "Create a test conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes" ] }, "description": "«falas»: one per line, «Agente:» before the agent ones; the last one is from the person. The text is cleaned of personal data before being stored." } }, { "name": "Run the tests against the new version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes/execucoes", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes", "execucoes" ] }, "description": "Chosen drafts and/or proposed rules (only those different from the current ones count). Runs in the background (scheduler crm.agente_testes): each active conversation is answered by the current and the new version. 422 without target or without test conversations." } }, { "name": "A run with the comparison", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes/execucoes/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes", "execucoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Approve and publish, or reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes/execucoes/:id/decisao", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes", "execucoes", ":id", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "«aprovada»: the tested drafts become approved (clinical content only by clinical management; a draft changed after the run gives 409) and the proposed rules go to Settings. Audited." } }, { "name": "Update a test conversation", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/testes/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", "testes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Request detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Transcript, patient-reported notes, detected signs and recording only for users who can see the clinical record. Read is audited." } }, { "name": "Take over the request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/assumir", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "assumir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Hands the request to the team («passado_equipa»), records who took it and, if there is a written conversation, removes it from the assistant." } }, { "name": "Correct an agent answer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/correcao", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "correcao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates a knowledge-base draft («correção» category) linked to this request. Only used after approval; clinical content only by the clinical board. Effects: notification to approvers.", "body": { "mode": "raw", "raw": "{\n \"titulo\": \"Estacionamento\",\n \"texto\": \"A clínica tem estacionamento gratuito para pacientes no piso -1.\",\n \"clinico\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resolve the request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/resolver", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "resolver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Review a sample", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/revisao", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "revisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"estado\": \"a_corrigir\",\n \"nota\": \"Não ofereceu falar com uma pessoa.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create a test conversation from a request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/teste", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "teste" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Uses the conversation version without personal data (voice engine turns or transcript)." } }, { "name": "Validate the patient-reported notes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/agente/:id/validar", "host": [ "{{base_url}}" ], "path": [ "crm", "agente", ":id", "validar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Clinical team only (403 for others). May correct the text. The request becomes «validado».", "body": { "mode": "raw", "raw": "{\n \"notas\": \"Refere ligeiro ardor na zona recetora ao terceiro dia, sem febre.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Voices per language and variant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/voz/vozes", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "vozes" ] }, "description": "For each language: whether the agent speaks it, who listens and who speaks (local, external service or the phone system voice), the configured voice, warnings (Brazilian voice for pt-PT, local service without pt-PT…) and the last test. No model names." } }, { "name": "Test the voice of a language", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/voz/vozes/testar", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "vozes", "testar" ] }, "description": "Speaks a typical sentence of the variant, listens back and compares (similarity, detected language and variant, warnings). The audio comes as base64 to listen to. No patient data. Audited." } } ] }, { "name": "Marcador e chamadas", "item": [ { "name": "Call statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/chamadas/estatisticas", "host": [ "{{base_url}}" ], "path": [ "crm", "chamadas", "estatisticas" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Per person (answered, missed, out of hours, outbound, average callback time), calls to return in the last 7 days and heat map of inbound calls by weekday and hour." } }, { "name": "Call lists and statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/marcador", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Record the call outcome", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/marcador/contactos/:id/resultado", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", "contactos", ":id", "resultado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "When the person answered and the list has a script, requires the opening confirmation (identification and purpose) and the script's required fields. «ligar_mais_tarde» requires reagendar_em; «nao_atendeu» goes back to the queue up to the attempt limit; «pediu_nao_contactar» adds the number to the opt-out list and revokes marketing consent; «marcou_consulta» moves the lead to the booked-consultation stage. Effects: call updated, timeline, audit; the list finishes when no contacts remain.", "body": { "mode": "raw", "raw": "{\n \"resultado\": \"marcou_consulta\",\n \"abertura_feita\": true,\n \"respostas\": {\n \"data_preferida\": \"2026-11-05\",\n \"financiamento\": \"nao\"\n },\n \"notas\": \"Prefere manhãs.\",\n \"duracao_s\": 184\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Call (click to call)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/marcador/ligar", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", "ligar" ] }, "description": "Records the outbound call. If the clinic configured the PBX address, it asks the PBX to call (fornecedor = true); otherwise returns the tel: address for the device phone. Blocks (422) commercial calls without consent or to opted-out numbers. Limit: 120 per minute.", "body": { "mode": "raw", "raw": "{\n \"numero\": \"+351936000111\",\n \"contacto_id\": 4410\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List with script and contacts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/marcador/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Activate, pause or finish the list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/marcador/:id/estado", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", ":id", "estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"estado\": \"pausada\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Generate the list contacts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/marcador/:id/gerar", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", ":id", "gerar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Applies the list filter (reactivation, confirmations, stalled proposals, post-op or stage leads). In commercial lists it blocks contacts without marketing consent or customer exception and those on the opt-out list (motivo_bloqueio). A draft list becomes active." } }, { "name": "Next contact", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/marcador/:id/seguinte", "host": [ "{{base_url}}" ], "path": [ "crm", "marcador", ":id", "seguinte" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Reserves the next pending contact (or rescheduled one whose time has come) for the caller. Re-checks consent: a contact that can no longer be called is blocked and skipped. dados = null when the list is finished." } }, { "name": "Live calls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/telefonia/ao-vivo", "host": [ "{{base_url}}" ], "path": [ "crm", "telefonia", "ao-vivo" ] }, "description": "Ringing and ongoing calls of the clinic with the contact record (name, owner, open tasks, last contact). «controlo»: the phone system accepts commands." } }, { "name": "Answer, transfer or hang up via the phone system", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/telefonia/chamadas/:id/controlo", "host": [ "{{base_url}}" ], "path": [ "crm", "telefonia", "chamadas", ":id", "controlo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Sends the command to the phone system address (crm.telefonia.controlo_url, https). Answer connects to the personal extension of the requester; transfer accepts utilizador_id, departamento or extensao. 409 without a configured address or outside production; 502 if the phone system refuses. Audited." } }, { "name": "Results per clinic number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/telefonia/numeros", "host": [ "{{base_url}}" ], "path": [ "crm", "telefonia", "numeros" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Voice menu for the editor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/voz/menus/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "menus", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "General data, validated tree, hours, closed days, out-of-hours, holiday, linked numbers, current moment and the editor options (destinations, departments with extension, languages, keys, recorded messages). 503 «por_instalar» before the migration." } }, { "name": "Save and publish a voice menu", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/voz/menus/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "menus", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Saves the whole menu and publishes a new version (the phone system uses it at once). Per-field errors (nos.N.opcoes.M.tecla, inicio…). Only one main menu per clinic. Audited." } }, { "name": "Listen to a step message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/voz/menus/:id/ouvir", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "menus", ":id", "ouvir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Synthesised speech of the text (≤ 600 characters, no patient data) in the chosen language, with the same speech service as the calls. 503 «fala_indisponivel» if no speech service answers." } }, { "name": "Simulate a call in the menu", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/voz/menus/:id/simular", "host": [ "{{base_url}}" ], "path": [ "crm", "voz", "menus", ":id", "simular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Runs the inputs in order («1», «#», spoken text or empty = no answer) over the saved menu or the sent tree (not saved yet), with optional moment and caller number. Calls no one and generates no speech.", "body": { "mode": "raw", "raw": "{\n \"entradas\": [\n \"2\",\n \"pós-operatório\",\n \"\"\n ],\n \"momento\": \"aberto\",\n \"lingua\": \"pt-PT\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Caixa de entrada", "item": [ { "name": "Inbox", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/conversas", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas" ], "query": [ { "key": "fila", "value": "", "disabled": true }, { "key": "canal", "value": "", "disabled": true }, { "key": "estado", "value": "", "disabled": true }, { "key": "departamento", "value": "", "disabled": true } ] }, "description": "Conversations from every channel, newest first. meta.contagens has the count per queue (minhas, por_atribuir, ia, atrasadas, todas)." } }, { "name": "Conversation with messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id" ], "query": [ { "key": "depois_de", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Up to 400 messages, internal notes included. With depois_de only new messages are returned (to refresh without reloading). Clinical-department content and photos filtered by permissions. First read is audited." } }, { "name": "Take over the conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/assumir", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "assumir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Team members only. Assigns the conversation to the caller and turns off the virtual assistant for it." } }, { "name": "Assign to a person", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/atribuir", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "atribuir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"utilizador_id\": 14\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Supervisor comment on the rating", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/avaliacao", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "avaliacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"comentario\": \"Resposta rápida e clara. Usar a resposta rápida do horário.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/estado", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "When resolving, if enabled by the clinic, asks the contact for a 1-5 rating. A new message reopens the conversation.", "body": { "mode": "raw", "raw": "{\n \"estado\": \"resolvida\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reply or add an internal note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/mensagens", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "mensagens" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With nota=true stores a team-only note. Without it, sends through the conversation channel (or the given «canal») via the platform delivery service, which applies quiet hours, the opt-out list and the WhatsApp 24 h window. «original» keeps the text before translation. Effects: first response and target time updated, sequences stop, delivery status tracked from channel callbacks, audit.", "body": { "mode": "raw", "raw": "{\n \"corpo\": \"Olá Ricardo! O valor depende da avaliação. Podemos marcar uma consulta gratuita esta semana?\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend a failed message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/mensagens/:mensagem_id/reenviar", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "mensagens", ":mensagem_id", "reenviar" ], "variable": [ { "key": "id", "value": "1" }, { "key": "mensagem_id", "value": "1" } ] }, "description": "Resends through the given channel (one of the conversation's canais_reenvio) or the same channel.", "body": { "mode": "raw", "raw": "{\n \"canal\": \"sms\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "AI reply draft", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/sugerir", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "sugerir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft based on the history and the approved knowledge base («respostas» use). Never sent without review. 403 if the conversation content is reserved to the clinical team. Limit: 30 per minute." } }, { "name": "Translate a text before sending", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/traduzir", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "traduzir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Uses the AI assistant configured for the «traducao» use (local service, then the external fallback). By default translates into the conversation language. 409 when the assistant is not configured or did not answer. Limit: 60 per minute.", "body": { "mode": "raw", "raw": "{\n \"texto\": \"Podemos marcar a avaliação para quinta-feira às 15h?\",\n \"para\": \"fr\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Transfer to another department", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/conversas/:id/transferir", "host": [ "{{base_url}}" ], "path": [ "crm", "conversas", ":id", "transferir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Clears the owner, records the transfer and leaves a note. Effects: department notification, audit.", "body": { "mode": "raw", "raw": "{\n \"departamento\": \"enfermagem\",\n \"nota\": \"Descreve vermelhidão na zona dadora.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Funil e leads", "item": [ { "name": "Funnel board", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/funil", "host": [ "{{base_url}}" ], "path": [ "crm", "funil" ], "query": [ { "key": "f", "value": "", "disabled": true } ] }, "description": "Stages with lead cards, totals, indicators (open, unanswered past target, stalled proposals, won this month, open value), this month's goals and filter options. Respects the module scope: sales users with «own» scope see their leads and unassigned ones." } }, { "name": "Time in each funnel stage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/funil/tempos", "host": [ "{{base_url}}" ], "path": [ "crm", "funil", "tempos" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "funil_id", "value": "", "disabled": true }, { "key": "responsavel_id", "value": "", "disabled": true } ] }, "description": "Average per stage and owner of the stays that ended in the period (default: 90 days), plus leads still in each stage. A stay counts for whoever owns the lead when it leaves the stage. Also included in GET /crm/funil («tempos», «kpis.ciclo_medio_segundos» and each column's average)." } }, { "name": "Create a lead (external forms, ads)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads", "host": [ "{{base_url}}" ], "path": [ "crm", "leads" ] }, "description": "Entry point for external forms and lead ads (Meta, Google). Normalises phone and email; the tax number is kept only as a search code. The same phone or email as an open lead updates that lead instead of duplicating it (and returns it); weak matches create the lead flagged «possible duplicate»; a recognised patient is linked. Then: initial stage, distribution (round robin or rules, skipping absences), first-response target time, score. Effects: timeline, stage tasks, sequence enrolment, owner notification, audit and lead.criado webhook.", "body": { "mode": "raw", "raw": "{\n \"origem\": \"meta\",\n \"nome\": \"Ricardo Almeida\",\n \"email\": \"ricardo.almeida@exemplo.pt\",\n \"telefone\": \"912345678\",\n \"idioma\": \"pt-PT\",\n \"procedimento_id\": 3,\n \"campanha\": \"capilar-outono\",\n \"utm_source\": \"facebook\",\n \"utm_medium\": \"cpc\",\n \"utm_campaign\": \"capilar-outono\",\n \"clique_id\": \"fb.1.1730100000.AbCdEf\",\n \"consentimento_contacto\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lead detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/leads/:id", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Contact data, source, stage, decision, next action, marketing consent, recent conversations and calls, commercial timeline and possible duplicates. «valor_estimado» only with financeiro.valores. Read is audited." } }, { "name": "Assign owner", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/atribuir", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "atribuir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Null removes the owner. The person must belong to the clinic. Effects: notification to the person, audit.", "body": { "mode": "raw", "raw": "{\n \"responsavel_id\": 14\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Convert to patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/converter", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "converter" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates the patient from the lead data (or uses the linked patient) and opens the episode. Idempotent: repeating returns the same patient. 409 if the lead was anonymised or the clinical record is unavailable. Effects: sequences stop, timeline, audit and lead.convertido webhook." } }, { "name": "Record the contact's decision", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/decisao", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Undecided and declined require a reason. The estimated value is only accepted from users who can see values. Recalculates the score. Effects: timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"indeciso\",\n \"motivo_indecisao\": \"Quer decidir depois do verão.\",\n \"valor_estimado\": 4200\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Possible duplicates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/duplicados", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "duplicados" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Leads with the same phone, email, tax number or name and birth date. «forte» = phone or email." } }, { "name": "Change stage", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/fase", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "fase" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Moves the lead (with its position in the column). For a «lost» stage the loss reason is required (422 without it). Effects: timeline, stage automatic tasks, sequence enrolment/stop, pending referral reward when won, audit and lead.fase_alterada webhook.", "body": { "mode": "raw", "raw": "{\n \"fase_id\": 9,\n \"ordem\": 0,\n \"motivo_perda\": \"preco\",\n \"motivo_perda_detalhe\": \"Escolheu uma clínica no estrangeiro.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Merge a duplicate lead into this one", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/fundir", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "fundir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Conversations, calls, tasks, agent requests and timeline move to the lead in the path; the duplicate is marked as merged. Effects: timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"duplicado_id\": 790\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Set the next action", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/crm/leads/:id/proxima-acao", "host": [ "{{base_url}}" ], "path": [ "crm", "leads", ":id", "proxima-acao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"proxima_acao\": \"Ligar para marcar consulta\",\n \"proxima_acao_em\": \"2026-10-29T10:00:00+00:00\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Definições", "item": [ { "name": "Settings groups with values", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/definicoes", "host": [ "{{base_url}}" ], "path": [ "definicoes" ] }, "description": "Each field: {chave, tipo, rotulo, ajuda, secao, padrao, opcoes, min, max, obrigatorio, valor, definido}. Secrets are never returned: valor null and definido true|false." } }, { "name": "Save settings of one group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/definicoes", "host": [ "{{base_url}}" ], "path": [ "definicoes" ] }, "description": "An empty secret keeps the value; to clear a secret send limpar:{chave:true}.", "body": { "mode": "raw", "raw": "{\n \"grupo\": \"seguranca\",\n \"valores\": {\n \"seguranca.sessao_minutos\": 30\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send a test email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/definicoes/email/testar", "host": [ "{{base_url}}" ], "path": [ "definicoes", "email", "testar" ] }, "description": "«plataforma» requires a superadministrator; «clinica» requires Settings › Edit. Uses the stored data of that server. Failures return ok:false with a category (incompleto, ligacao, autenticacao, cifra, remetente, tempo, outro) and a readable message. Never returns the password. Audited.", "body": { "mode": "raw", "raw": "{\n \"ambito\": \"clinica\",\n \"para\": \"geral@clinicaporto.pt\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Clinic first steps (setup assistant)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/primeiros-passos", "host": [ "{{base_url}}" ], "path": [ "primeiros-passos" ] }, "description": "Steps dados_legais, equipa, horarios, tipos_marcacao, consentimentos, motor, pagamentos, faturacao, email and canais, each with a state (feito|por_fazer|dispensado|nao_aplicavel), detail and link {web, app}; the state is computed from the existing configuration. Requires Settings › Edit." } }, { "name": "Dismiss (or restore) a step", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/primeiros-passos/:passo/dispensar", "host": [ "{{base_url}}" ], "path": [ "primeiros-passos", ":passo", "dispensar" ], "variable": [ { "key": "passo", "value": "1" } ] }, "description": "" } } ] }, { "name": "Análise e plano", "item": [ { "name": "Day 0 areas and implanted per zone", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/execucoes/cirurgias/:cirurgia_id", "host": [ "{{base_url}}" ], "path": [ "execucoes", "cirurgias", ":cirurgia_id" ], "variable": [ { "key": "cirurgia_id", "value": "1" } ] }, "description": "Created from the approved plan on first read. View: bloco.registo or ficha.plano." } }, { "name": "Confirm the day 0 areas", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/execucoes/:id/areas", "host": [ "{{base_url}}" ], "path": [ "execucoes", ":id", "areas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Recalculate with the day 0 areas (without saving)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/execucoes/:id/areas/calcular", "host": [ "{{base_url}}" ], "path": [ "execucoes", ":id", "areas", "calcular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Record implanted grafts per zone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/execucoes/:id/implantados", "host": [ "{{base_url}}" ], "path": [ "execucoes", ":id", "implantados" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With planeamento.dia0_confirmar_antes, requires the confirmed areas." } }, { "name": "Re-read the panel counts (actual hairs per graft)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/execucoes/:id/real", "host": [ "{{base_url}}" ], "path": [ "execucoes", ":id", "real" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Update a layer", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/anotacoes/:id", "host": [ "{{base_url}}" ], "path": [ "galeria", "anotacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Delete a layer (the photo does not change)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/anotacoes/:id", "host": [ "{{base_url}}" ], "path": [ "galeria", "anotacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Drawings on the photo (vector layers)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/anotacoes", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "anotacoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Layers with stroke, arrow, text and measurement elements in 0–1 fractions of the image; the original photo never changes. Shared web/app drawing rule: 1000 px width reference. Measurements carry comprimento_px and, with a reference measurement (referencia_mm), comprimento_mm." } }, { "name": "Create a drawing layer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/anotacoes", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "anotacoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Linha frontal proposta\",\n \"elementos\": [\n {\n \"id\": \"e1\",\n \"tipo\": \"traco\",\n \"pontos\": [\n [\n 0.3,\n 0.22\n ],\n [\n 0.5,\n 0.18\n ],\n [\n 0.7,\n 0.22\n ]\n ],\n \"cor\": \"ouro\",\n \"espessura\": 3,\n \"tracejado\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export for communication (face blurred without image consent)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/exportar", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "exportar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Without a valid «imagens_comunicacao» consent, the export is ALWAYS a copy with the face blurred; with consent, blurring is optional. Simulations → 422. The original never changes; the export is audited.", "body": { "mode": "raw", "raw": "{\n \"finalidade\": \"comunicacao\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Locate the face (boxes)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/rostos", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "rostos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Vision AI detection (only with the patient's «ia» consent). Without detection, returns the typical region for the view (metodo «omissao»). Views without a face: metodo «nenhum»." } }, { "name": "Planned vs actual per zone and parameter suggestions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/afinacao", "host": [ "{{base_url}}" ], "path": [ "motor", "afinacao" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Apply suggestions to the parameter draft", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/afinacao/aplicar", "host": [ "{{base_url}}" ], "path": [ "motor", "afinacao", "aplicar" ] }, "description": "Only suggestions with enough cases; written to the latest draft. The current version only changes with clinical board approval." } }, { "name": "Accept, correct or reject the thirds", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/proporcoes/:id/decidir", "host": [ "{{base_url}}" ], "path": [ "planos", "proporcoes", ":id", "decidir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Accepted or corrected → «Facial thirds» drawing layer on the photo." } }, { "name": "Future loss, expectations, facial proportions and actual surgery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/analise", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "analise" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "perda_futura: expected grade, future grafts from the zone × grade table and whether the donor reserve suffices. expectativas: natural vs expected density per zone, normal-appearance threshold and the approved text. real: hairs per graft measured in the last surgery." } }, { "name": "Record the comparison shown to the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/expectativas/mostradas", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "expectativas", "mostradas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Stores who, when, the channel and the exact SHA-256 of what was shown. Only with the approved text.", "body": { "mode": "raw", "raw": "{\n \"canal\": \"presencial\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Family history (yes, no or unknown)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/perda-futura", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "perda-futura" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"historia_familiar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Propose the facial thirds on a frontal photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/proporcoes", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "proporcoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Vision AI proposal (proporcoes use; requires «ia» consent; needs the face, so it is not blurred). Pending until decided.", "body": { "mode": "raw", "raw": "{\n \"foto_id\": 3321\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Use the actual hairs per graft in the draft", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/usar-real", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "usar-real" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Count on the trichoscope image (proposal)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/analisar", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "analisar" ] }, "description": "FU by type, hairs and diameters proposed by the vision AI; the server converts diameters into calibre and classes and computes densities with the same calculation as manual counts. Pending until decided. Requires «ia» consent." } }, { "name": "Patient count proposals and agreement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/analises", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "analises" ], "query": [ { "key": "paciente_id", "value": "", "disabled": true }, { "key": "estado", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Accept, correct or reject the proposal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tricoscopia/analises/:id/decidir", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "analises", ":id", "decidir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "«aceite» saves the field with the proposed values; «corrigida» with the sent values; «recusada» requires a reason.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"corrigida\",\n \"valores\": {\n \"uf_1\": 17,\n \"uf_2\": 39,\n \"uf_3\": 16,\n \"uf_4\": 2\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record a trichogram or hair mass index", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/medicoes", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "medicoes" ] }, "description": "" } }, { "name": "Calculate a measurement (without saving)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tricoscopia/medicoes/calcular", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "medicoes", "calcular" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"tricograma\",\n \"anagenio\": 42,\n \"telogenio\": 8,\n \"aparado_em\": \"2026-10-27 10:00:00\",\n \"data\": \"2026-10-29 10:30:00\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a measurement", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/medicoes/:id", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "medicoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Delete a measurement", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/medicoes/:id", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "medicoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Trichogram, hair mass and same-point series", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/pacientes/:paciente_id/seguimento", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "pacientes", ":paciente_id", "seguimento" ], "variable": [ { "key": "paciente_id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Ficheiros", "item": [ { "name": "Upload a file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ficheiros", "host": [ "{{base_url}}" ], "path": [ "ficheiros" ] }, "description": "Real type checked from the content; name replaced by a random one; images stripped of location metadata; clinical files encrypted at rest. Limits in Settings › Security." } }, { "name": "Signed link (15 minutes)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ficheiros/:id/url", "host": [ "{{base_url}}" ], "path": [ "ficheiros", ":id", "url" ], "query": [ { "key": "descarregar", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The link re-checks the requester permissions when opened." } } ] }, { "name": "Formulários", "item": [ { "name": "Ready-to-adapt templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/formularios/biblioteca", "host": [ "{{base_url}}" ], "path": [ "formularios", "biblioteca" ] }, "description": "Forms flagged as templates (up to 200), by type and name, with the number of questions and steps. To use one, duplicate it (POST /formularios/{id}/duplicar). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Upload the photo of a question (team)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/formularios/ficheiro", "host": [ "{{base_url}}" ], "path": [ "formularios", "ficheiro" ] }, "description": "Same as POST equipa/formularios/ficheiro on the web. Images only, up to 15 MB: real type checked from the bytes, executable extensions refused, random name, stored outside the public area as a clinical file of the patient. No photo is collected before the «fotografias_clinicas» authorisation: already recorded for the patient or declared now with consentimento_fotos = 1 (otherwise 422 on «ficheiro»). A given patient must exist (422) and be in clinical scope (403). Returns the identifier to use in the question answer. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 60 requests per 10 minutes per IP address (only data-changing requests count)." } }, { "name": "Readable response", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/formularios/respostas/:id", "host": [ "{{base_url}}" ], "path": [ "formularios", "respostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Team and integrations. Response with its version schema, the values, the formatted items (question, section, readable text, alarm), source, status, score and band, who validated and the return information request. A patient response requires the patient in clinical scope. Read is audited («ver», formularios_respostas). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per team token; integrations use the per-minute limit set on the integration client (429 with Retry-After)." } }, { "name": "Editable copy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/formularios/:id/duplicar", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "duplicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates a new form (version 1, inactive, not a template) with the original schema, type, technique, language and deadline; new key derived from the original; given name or «Cópia de …» (up to 160). Effects: version copy, «criar» audit. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Questionário prévio — FUE\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Form for the builder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/formularios/:id/editor", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "editor" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Form, current schema, catalogue of the 12 question types, published versions (up to 50), translations (same key in other languages), number of responses received, whether the caller may edit and whether translation by the clinic's AI assistant is configured. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Save the schema (new version if there are responses)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/formularios/:id/esquema", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "esquema" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Validates and normalises the schema: 1 to 20 steps, up to 300 questions, types from the closed list, unique keys in a-z0-9_ format, options and columns in their own format, conditions only for existing questions (others are dropped), up to 10 score bands; per-question errors → 422 with «pergunta_N». If the current version already has responses, a new version is published (old responses stay tied to their version schema). Also accepts nome (up to 160), descricao (up to 400), expira_dias (1–365; 0 or empty = settings deadline) and ativo. Effects: version copy, «alterar» audit. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"esquema\": {\n \"passos\": [\n {\n \"chave\": \"p1\",\n \"titulo\": \"Saúde geral\",\n \"descricao\": \"\",\n \"seccoes\": [\n {\n \"chave\": \"s1_1\",\n \"titulo\": \"Antecedentes\",\n \"descricao\": \"\",\n \"perguntas\": [\n {\n \"chave\": \"anticoagulantes\",\n \"tipo\": \"simnao\",\n \"rotulo\": \"Toma anticoagulantes?\",\n \"ajuda\": \"\",\n \"obrigatorio\": true,\n \"preencher\": true,\n \"pontos_sim\": null,\n \"alarme_sim\": true,\n \"alerta\": {\n \"tipo\": \"anticoagulante\",\n \"gravidade\": \"alta\",\n \"quando\": [\n \"sim\"\n ]\n }\n },\n {\n \"chave\": \"qual_anticoagulante\",\n \"tipo\": \"texto\",\n \"rotulo\": \"Qual?\",\n \"ajuda\": \"\",\n \"obrigatorio\": false,\n \"preencher\": true,\n \"max\": 200,\n \"condicao\": {\n \"pergunta\": \"anticoagulantes\",\n \"operador\": \"=\",\n \"valor\": \"sim\"\n }\n },\n {\n \"chave\": \"impacto\",\n \"tipo\": \"escala\",\n \"rotulo\": \"Quanto o incomoda a queda de cabelo?\",\n \"ajuda\": \"\",\n \"obrigatorio\": true,\n \"preencher\": false,\n \"min\": 0,\n \"max\": 10,\n \"passo\": 1,\n \"rotulo_min\": \"Nada\",\n \"rotulo_max\": \"Muito\",\n \"pontuar\": true,\n \"alarme_min\": null\n }\n ]\n }\n ]\n }\n ],\n \"pontuacao\": {\n \"ativa\": true,\n \"rotulo\": \"Impacto\",\n \"modo\": \"soma\",\n \"pergunta\": null,\n \"faixas\": [\n {\n \"min\": 0,\n \"max\": 4,\n \"rotulo\": \"Baixo\",\n \"tom\": \"sucesso\"\n },\n {\n \"min\": 5,\n \"max\": 10,\n \"rotulo\": \"Elevado\",\n \"tom\": \"aviso\"\n }\n ]\n },\n \"alarmes\": {\n \"departamento\": \"enfermagem\"\n }\n },\n \"nome\": \"Questionário prévio — FUE\",\n \"expira_dias\": 14,\n \"ativo\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fill-in request by link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/formularios/:id/pedidos", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "pedidos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The route has no permission of its own: the controller requires «edit» on ficha.identificacao (reception) OR on ficha.clinica — requesting a form shows no clinical content. Team and integrations. Recipient: paciente_id (must be in identification scope, 403) or lead_id. Active forms only (missing or inactive → 422). Creates the «pendente» request with a 32-byte token (only its SHA-256 is stored) and the form or settings deadline (1 to 365 days). Channel email, sms or whatsapp sends the service message with only the questionnaire name, the link and the deadline; «ligacao» and «portal» send no message. The returned link is the web page; the token (last segment) also serves GET /publico/formularios/{token}. expira_em comes in ISO 8601 (e.g. «2026-11-12T09:40:00+00:00»). Effects: timeline (with patient), «enviar» audit. Limit (default): 120 requests per minute per team token; integrations use the per-minute limit set on the integration client (429 with Retry-After). Additional limit: 60 requests per 10 minutes per IP address (only data-changing requests count).", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"canal\": \"email\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Schema and pre-fill for the team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/formularios/:id/preencher", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "preencher" ], "query": [ { "key": "paciente_id", "value": "", "disabled": true }, { "key": "episodio_id", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Form, current schema and pre-fill values: the patient previous responses (awaiting validation or validated) to the same form — same key, any language; questions with «preencher» off, photos and signatures are left out. With paciente_id the patient must exist (422) and be in clinical scope (403). With episodio_id the episode must belong to that patient (422 on «episodio_id») and the most recent response of that episode takes priority in the pre-fill. Compatible additions: «consentimentos» (authorisations the patient has not given yet: the team declares them when collected in person; without them the submission is refused with 422), «episodio_id» and «episodio». Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Save a response (team or integration)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/formularios/:id/respostas", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "respostas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Team and integrations (an integration clinical scopes only apply once the client clinical justification is approved). Answers are validated against the current version schema: questions hidden by the conditional rule are dropped, missing required ones and values of the wrong type → 422 with the question key. Values: texto and textoLongo (up to the question maximum), escolha (option value), multipla (list or comma-separated), escala (integer in range), numero (in range; rounded to the decimals), simnao («sim»/«nao»), data, grelha ({row: column}), fotografia (file identifiers of the clinic, belonging to the patient or without owner), assinatura (file identifier or PNG data URL up to 2 MB). Saved by the team it is «validado»; by an integration it gets the «agente» source and «por_validar». A given patient must exist (422) and be in scope (403). Effects: encrypted answers, score and band, alerts declared in the schema (awaiting validation when not the team), alarm → urgent task and notice to the schema department, pre-assessment → medical review task, timeline, «criar» audit, formulario.respondido webhook (without answers). Legal basis before saving health data: with a patient or lead, the «tratamento_clinico» consent (and «fotografias_clinicas» when the answers contain photos) must already be recorded or be declared in «consentimentos» ({finalidade: true}); without it nothing is saved and the response is 422 with the per-field error «consentimentos.». Declarations are recorded immutably («presencial» channel by the team, «agente_voz» by an integration). Limit (default): 120 requests per minute per team token; integrations use the per-minute limit set on the integration client (429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"respostas\": {\n \"anticoagulantes\": \"sim\",\n \"qual_anticoagulante\": \"Apixabano 5 mg\",\n \"impacto\": 7\n },\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"idioma\": \"pt-PT\",\n \"consentimentos\": {\n \"tratamento_clinico\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Translate with the clinic's AI assistant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/formularios/:id/traduzir", "host": [ "{{base_url}}" ], "path": [ "formularios", ":id", "traduzir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Translates the name, description and every schema text into the requested language (the schema carries no patient data). Creates a form with the same key in that language — or updates the existing one — always inactive until someone reviews and activates it. 422: language outside the list, same as the original, use not configured or assistant failure. Effects: version copy, «criar» audit with the model used. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 10 requests per 10 minutes per IP address (only data-changing requests count).", "body": { "mode": "raw", "raw": "{\n \"idioma\": \"en\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Galeria clínica", "item": [ { "name": "Previous photo of the same view (overlay)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/anterior", "host": [ "{{base_url}}" ], "path": [ "galeria", "anterior" ], "query": [ { "key": "paciente_id", "value": "", "disabled": true }, { "key": "vista", "value": "", "disabled": true }, { "key": "excluir", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "3D capture and sensor protocol parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/captura3d/configuracao", "host": [ "{{base_url}}" ], "path": [ "galeria", "captura3d", "configuracao" ] }, "description": "Warning distances (cm) and max speeds, head radius, reconstruction grid, coverage grid (same as the server), minimum coverage, level/distance tolerances and the guided-photo protocol." } }, { "name": "Create capture", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/capturas", "host": [ "{{base_url}}" ], "path": [ "galeria", "capturas" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"tipo\": \"seguimento\",\n \"protocolo_id\": 4,\n \"marco_id\": 5120\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload the photo of a view", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/capturas/:id/fotos", "host": [ "{{base_url}}" ], "path": [ "galeria", "capturas", ":id", "fotos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Type checked by content, EXIF/GPS stripped, encrypted at rest. Server-side quality scoring (resolution, Laplacian-variance sharpness, brightness); insufficient quality flags the capture for repetition." } }, { "name": "Request the capture be repeated", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/capturas/:id/repetir", "host": [ "{{base_url}}" ], "path": [ "galeria", "capturas", ":id", "repetir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Pouca luz na vista do topo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Compare two photos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/comparar", "host": [ "{{base_url}}" ], "path": [ "galeria", "comparar" ], "query": [ { "key": "a", "value": "", "disabled": true }, { "key": "b", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Copy with the face blurred for export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/desfocar", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "desfocar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Region as image fractions (0–1). The original is unchanged. «export» audit.", "body": { "mode": "raw", "raw": "{\n \"x\": 0.3,\n \"y\": 0.05,\n \"largura\": 0.4,\n \"altura\": 0.35\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Tags, zone, album and view", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/etiquetas", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "etiquetas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"etiquetas\": [\n \"linha frontal\",\n \"controlo\"\n ],\n \"album\": \"Casos 2026\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Selective sharing with the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/partilhar", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"partilhar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Accept or reject a patient photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/fotos/:id/verificar", "host": [ "{{base_url}}" ], "path": [ "galeria", "fotos", ":id", "verificar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Rejecting requires a reply (stored encrypted). The patient receives a notification without clinical details.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"rejeitada\",\n \"resposta\": \"Repita com luz natural, sem flash.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload 3D model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d" ] }, "description": "GLB, glTF, OBJ, PLY, STL or USDZ, validated by content; stored encrypted. The server reads the mesh (vertices, triangles, area, unit) and measures scalp coverage; the app capture sends origin lidar/profundidade, the device and captura_meta (duration, samples, distance/speed/tracking warnings, % of time with warnings, hex coverage map). Response includes «aviso» when the mesh cannot be read." } }, { "name": "Revoke a preview link", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/partilhas/:id/revogar", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", "partilhas", ":id", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "3D model with everything the viewer needs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Signed file link, mesh, head frame, coverage, scale, capture data, markings with triangles, trichoscopy points, hairline, simulated hair, other models, plans, preview links and permissions." } }, { "name": "Landmarks, coverage, scale, quality and areas", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"escala_confirmada\": true,\n \"cobertura_pct\": 94.5,\n \"zonas\": {\n \"linha_frontal\": 15.2,\n \"coroa\": 68.9\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Difference map against another model of the patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/diferencas", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "diferencas" ], "query": [ { "key": "com", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Alignment by common landmarks (≥ 3, Horn) refined by closest points. distancias_b64: little-endian int16 per vertex in tenths of mm (−32768 = no match)." } }, { "name": "Confirm scale with the reference (sticker or ruler)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/escala", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "escala" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Two mesh points and the real length in mm. Stores the factor, confirms the scale, returns the difference to the previous scale and re-measures all zones.", "body": { "mode": "raw", "raw": "{\n \"a\": {\n \"x\": 0.031,\n \"y\": 0.072,\n \"z\": 0.061\n },\n \"b\": {\n \"x\": 0.05,\n \"y\": 0.071,\n \"z\": 0.058\n },\n \"comprimento_mm\": 20,\n \"metodo\": \"marcador\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Hairline in 3D (with symmetry)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/linha-frontal", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "linha-frontal" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Ordered points. Returns length (cm), height above glabella (cm), mean asymmetry (mm) and 2D diagram projection. Empty list deletes." } }, { "name": "Active preview links", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/partilhas", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "partilhas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Create a temporary link to view the model on another device", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/partilhas", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "partilhas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Returns /m3d/ (public page with only the model, no personal data). Only the code’s sha256 is stored. Valid 5–240 minutes.", "body": { "mode": "raw", "raw": "{\n \"minutos\": 30,\n \"sem_rosto\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Position of a mesh point on the 2D diagram", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/ponto-diagrama", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "ponto-diagrama" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Azimuthal projection from the vertex in the head frame. Returns x, y (0–1), suggested subzone and frame source. To save a trichoscopy field with a 3D point, send ponto.modelo3d = {id, x, y, z} to POST /tricoscopia." } }, { "name": "Simulated hair parameters per zone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/simulacao", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "simulacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Per marked zone: density, angle, direction, calibre, wave, colour and length. Illustrative only." } }, { "name": "Mark a zone on the mesh (area measured on the server)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/zonas/:zona", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "zonas", ":zona" ], "variable": [ { "key": "id", "value": "1" }, { "key": "zona", "value": "1" } ] }, "description": "triangulos as ranges «a-b,c,…» in canonical mesh order. Each triangle belongs to one zone only. Returns all markings with skin and surface area (cm²), perimeter (cm) and contour error (%), and the updated model.", "body": { "mode": "raw", "raw": "{\n \"triangulos\": \"120-388,402,410-415\",\n \"ferramenta\": \"pincel\",\n \"espessura_cabelo_mm\": 2\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a zone marking", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/modelos3d/:id/zonas/:zona", "host": [ "{{base_url}}" ], "path": [ "galeria", "modelos3d", ":id", "zonas", ":zona" ], "variable": [ { "key": "id", "value": "1" }, { "key": "zona", "value": "1" } ] }, "description": "" } }, { "name": "Patient gallery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/pacientes/:paciente_id", "host": [ "{{base_url}}" ], "path": [ "galeria", "pacientes", ":paciente_id" ], "query": [ { "key": "f[marco]", "value": "", "disabled": true }, { "key": "f[vista]", "value": "", "disabled": true }, { "key": "f[zona]", "value": "", "disabled": true }, { "key": "f[etiqueta]", "value": "", "disabled": true }, { "key": "f[album]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[simulacao]", "value": "", "disabled": true } ], "variable": [ { "key": "paciente_id", "value": "1" } ] }, "description": "Captures with protocol slots (photo per view and missing views), filtered photos, 3D models, protocols, milestones, tags, albums and pending count. 15-minute signed links. Audited." } }, { "name": "Patient photos pending review", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/por-verificar", "host": [ "{{base_url}}" ], "path": [ "galeria", "por-verificar" ] }, "description": "" } }, { "name": "Active photo protocols", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/galeria/protocolos", "host": [ "{{base_url}}" ], "path": [ "galeria", "protocolos" ] }, "description": "" } } ] }, { "name": "Chat do site e subscrições", "item": [ { "name": "One-click unsubscribe (List-Unsubscribe-Post)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/anular/:codigo", "host": [ "{{base_url}}" ], "path": [ "ganchos", "anular", ":codigo" ], "variable": [ { "key": "codigo", "value": "1" } ] }, "description": "Used by email clients (RFC 8058). The clinic comes from the send record the code belongs to. Effects: contact added to the email opt-out list, marketing consent revoked, unsubscribe count.", "auth": { "type": "noauth" } } }, { "name": "Campaign email open", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/m/a/:codigo/:assinatura", "host": [ "{{base_url}}" ], "path": [ "m", "a", ":codigo", ":assinatura" ], "variable": [ { "key": "codigo", "value": "1" }, { "key": "assinatura", "value": "1" } ] }, "description": "1×1 image included only in commercial emails with measurement on and for people with explicit consent. HMAC signature of the code («.gif» at the end). Records the first open and the open count of the send, without storing address, device or browser. Always returns the same GIF, without cookies or cache.", "auth": { "type": "noauth" } } }, { "name": "Campaign click tracking", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/m/c/:codigo", "host": [ "{{base_url}}" ], "path": [ "m", "c", ":codigo" ], "query": [ { "key": "l", "value": "", "disabled": true }, { "key": "s", "value": "", "disabled": true } ], "variable": [ { "key": "codigo", "value": "1" } ] }, "description": "Records the click (email link «l») on the send and redirects to the original destination. Destinations always come from the approved content, never from the request.", "auth": { "type": "noauth" } } }, { "name": "Website chat", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/publico/chat", "host": [ "{{base_url}}" ], "path": [ "publico", "chat" ] }, "description": "No session; used by the site widget (sends the site CSRF code). Actions: iniciar (name, email or phone, text, consent → returns the conversation token), mensagem, disponibilidade (free slots), marcar (booking request for the front desk) and avaliar (1-5). Trap field «website_url»: if filled, the response looks successful and nothing is stored. The clinic is the site's public clinic. Limit: 20 per minute per IP.", "body": { "mode": "raw", "raw": "{\n \"acao\": \"iniciar\",\n \"nome\": \"Ana Lopes\",\n \"email\": \"ana.lopes@exemplo.pt\",\n \"texto\": \"Boa tarde, fazem implante de sobrancelhas?\",\n \"consentimento\": true,\n \"website_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Website chat messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/chat/:token", "host": [ "{{base_url}}" ], "path": [ "publico", "chat", ":token" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "Exchanged messages (no internal notes), conversation status and whether rating is available. Only with the token returned by «iniciar» (stored only as a cryptographic digest). Limit: 40 per minute.", "auth": { "type": "noauth" } } }, { "name": "Confirm the subscription (double opt-in)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/subscricao/confirmar/:codigo", "host": [ "{{base_url}}" ], "path": [ "subscricao", "confirmar", ":codigo" ], "variable": [ { "key": "codigo", "value": "1" } ] }, "description": "Link in the «Confirm your subscription» email. Records the marketing consent with date and source and marks the subscription as confirmed. Single-use code.", "auth": { "type": "noauth" } } }, { "name": "«Unsubscribe» page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/subscricao/:codigo", "host": [ "{{base_url}}" ], "path": [ "subscricao", ":codigo" ], "variable": [ { "key": "codigo", "value": "1" } ] }, "description": "HTML page to confirm the unsubscribe. Clinic and contact come from the send record.", "auth": { "type": "noauth" } } }, { "name": "Confirm «Unsubscribe»", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/subscricao/:codigo", "host": [ "{{base_url}}" ], "path": [ "subscricao", ":codigo" ], "variable": [ { "key": "codigo", "value": "1" } ] }, "description": "Page form (with the CSRF code). Effects: channel opt-out list, marketing consent revoked, commercial sequences stopped, unsubscribe count.", "auth": { "type": "noauth" } } } ] }, { "name": "Avisos de fornecedores (comercial)", "item": [ { "name": "Invoicing software document status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/faturacao", "host": [ "{{base_url}}" ], "path": [ "ganchos", "faturacao" ] }, "description": "Updates a «pedido» document with the number, ATCUD and final status. The secret (X-AX-Segredo) is compared with faturacao.gancho_segredo of the clinic owning the document.", "body": { "mode": "raw", "raw": "{\n \"externo_id\": \"84512233\",\n \"estado\": \"emitido\",\n \"numero\": \"FR A2026/118\",\n \"atcud\": \"JJ3KX9QW-118\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Payment notification (Ifthenpay)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/pagamentos", "host": [ "{{base_url}}" ], "path": [ "ganchos", "pagamentos" ], "query": [ { "key": "key", "value": "", "disabled": false }, { "key": "referencia", "value": "", "disabled": true }, { "key": "pedido", "value": "", "disabled": true }, { "key": "id_pedido", "value": "", "disabled": true }, { "key": "valor", "value": "", "disabled": true }, { "key": "metodo", "value": "", "disabled": true } ] }, "description": "URL to configure at the provider: /ganchos/pagamentos?key=[ANTI_PHISHING_KEY]&referencia=[REFERENCE]&valor=[AMOUNT]&pedido=[ORDER_ID]&id_pedido=[REQUEST_ID]&metodo=[PAYMENT_METHOD]. The clinic is resolved from the payment record (Multibanco reference, MB WAY request or link identifier) and the anti-phishing key is compared with that clinic's. The amount must match; the status is confirmed with the provider when possible. Every notification is logged (no personal data). Responds in plain text.", "auth": { "type": "noauth" } } }, { "name": "Stripe Terminal notification (signed)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/terminais/stripe", "host": [ "{{base_url}}" ], "path": [ "ganchos", "terminais", "stripe" ] }, "description": "Events payment_intent.succeeded, payment_intent.payment_failed, payment_intent.canceled, terminal.reader.action_succeeded and terminal.reader.action_failed. Stripe-Signature header (HMAC-SHA256 of «t.body» with terminais.stripe.segredo_gancho of the clinic owning the charge, 5-minute tolerance). Confirmed by the API (payment_intent «succeeded» and correct amount_received) before marking paid.", "auth": { "type": "noauth" } } }, { "name": "SumUp charge notification (Solo)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/terminais/sumup/:token", "host": [ "{{base_url}}" ], "path": [ "ganchos", "terminais", "sumup", ":token" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "return_url of each charge (event solo.transaction.updated). SumUp does not sign the notification: the 48-hex token, unique per charge (only its SHA-256 is stored), acts as the secret. The payment only becomes paid after confirmation by the SumUp API, with the right amount.", "auth": { "type": "noauth" } } } ] }, { "name": "Avisos de fornecedores (CRM)", "item": [ { "name": "Google lead forms", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/leads/google", "host": [ "{{base_url}}" ], "path": [ "ganchos", "leads", "google" ] }, "description": "Google format (lead_id, user_column_data, form_id, campaign_id, gcl_id, is_test, google_key). «google_key» identifies the clinic (crm.google.chave_leads, constant-time comparison; 401 on mismatch). The lead goes through the queue (idempotent by lead_id) and is created by the funnel; test submissions only confirm the connection. Body ≤ 256 KB. Limit: 300/min per IP.", "body": { "mode": "raw", "raw": "{\n \"lead_id\": \"TeSter-123-ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\n \"user_column_data\": [\n {\n \"column_id\": \"FULL_NAME\",\n \"string_value\": \"Ana Costa\"\n },\n {\n \"column_id\": \"EMAIL\",\n \"string_value\": \"ana@exemplo.pt\"\n },\n {\n \"column_id\": \"PHONE_NUMBER\",\n \"string_value\": \"+351912345678\"\n }\n ],\n \"form_id\": 123456,\n \"campaign_id\": 987654,\n \"gcl_id\": \"EAIaIQobChMI…\",\n \"is_test\": true,\n \"google_key\": \"••••\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "PBX events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/telefonia", "host": [ "{{base_url}}" ], "path": [ "ganchos", "telefonia" ] }, "description": "One event or {\"eventos\": […]}. The clinic is the owner of the secret (X-AX-Segredo) or signature (X-AX-Assinatura: sha256=HMAC of the body); if the destination number is in a clinic's numbers, only that clinic is tried. Effects: call recorded and linked to the patient/lead by number (new phone-source lead if unknown), missed call → «call back» task with target time, outbound call to a number with a missed call marks it as returned, recording stored only with consent (https or base64) and analysed (summary and script score), inbound SMS → inbox. Transcription: if the event carries «transcricao», that one is kept; a consented recording or voicemail without transcription stays pending and is transcribed by the clinic AI within minutes (scheduler crm.transcricoes; local service first, external only with the patient-data switch).", "body": { "mode": "raw", "raw": "{\n \"evento\": \"perdida\",\n \"chamada_id\": \"pbx-55a1c\",\n \"de\": \"+351912345678\",\n \"para\": \"+351210000000\",\n \"direcao\": \"entrada\",\n \"inicio\": \"2026-10-28T13:05:00+00:00\",\n \"duracao_s\": 0\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Voice agent events", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz" ] }, "description": "One event or {\"eventos\": […]} from the agent provider, grouped by conversa_id. Authentication and clinic via the clinic's agent secret (X-AX-Segredo or X-AX-Assinatura). Events: inicio, transcricao, resumo, intencao, alarme, idioma, marcacao, fim. Effects: agent request, lead when the contact is unknown, booking request for the front desk, alarm sign (clinic keyword or flagged by the provider) → immediately to nursing with an urgent task, passar_equipa → team notified, usage counted.", "body": { "mode": "raw", "raw": "{\n \"evento\": \"fim\",\n \"conversa_id\": \"va-20261027-2114-77\",\n \"canal\": \"voz\",\n \"telefone\": \"+351936000111\",\n \"nome\": \"Helena Duarte\",\n \"tipo\": \"marcacao\",\n \"intencao\": \"Remarcar consulta de revisão\",\n \"resumo\": \"Pede para mudar a consulta de quinta para a semana seguinte.\",\n \"aviso_ia\": true,\n \"identificacao_verificada\": true,\n \"duracao_s\": 143,\n \"passar_equipa\": true,\n \"motivo\": \"Remarcação precisa de confirmação da receção\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Own voice engine — answer audio", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/voz/audio/:token", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "audio", ":token" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "The audio of an answer requested with audio_modo = ligacao. Signed link, valid for 120 s and single use (404 once read or expired).", "auth": { "type": "noauth" } } }, { "name": "Approved knowledge base for the agent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/voz/conhecimento", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "conhecimento" ] }, "description": "Only content approved for the agent, mandatory AI notice, alarm signs, forbidden topics, recording notice and opening hours. Authenticated with the clinic agent secret (X-AX-Segredo).", "auth": { "type": "noauth" } } }, { "name": "Own voice engine — call end", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz/fim", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "fim" ] }, "description": "Closes the call (if still active), records the duration in the month usage and stores the full recording ONLY with consent (gravacao_base64 or https gravacao_url), deleted after crm.telefonia.gravacoes_dias. Can be called after «transferir» or «terminar» (only updates duration and recording). Works even if the clinic has since changed engine.", "body": { "mode": "raw", "raw": "{\n \"chamada_id\": \"pbx-7f3a-20261029-2214\",\n \"duracao_s\": 154,\n \"motivo\": \"desligou\",\n \"gravacao_consentida\": false\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Outbound agent — calls to make now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz/saida", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "saida" ] }, "description": "The bridge asks for the calls the agent must make (dialler lists with «who calls» = voice agent). Each contact is reserved for 10 minutes and checked again: objection list, consent/customer exception for commercial calls, clinic days and hours, list window, holidays, quiet hours and execution environment. The bridge dials «para» and, if answered, calls /ganchos/voz/sessao with the chamada_id and «modo»: «saida». Same secret and signature as the voice engine. Only with the own engine and outbound calls switched on.", "body": { "mode": "raw", "raw": "{\n \"max\": 5\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Outbound agent — unanswered call", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz/saida/resultado", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "saida", "resultado" ] }, "description": "For reserved calls that never reached /ganchos/voz/sessao. The contact goes back to the queue up to the maximum attempts; «numero_errado» closes it. An answered call ends in /ganchos/voz/fim, which records the outcome (confirmed, cancelled, rescheduled, interested, asked not to be contacted, follow-up done).", "body": { "mode": "raw", "raw": "{\n \"chamada_id\": \"ax-s-9f2c71d04e\",\n \"resultado\": \"nao_atendeu\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Own voice engine — call start", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz/sessao", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "sessao" ] }, "description": "Called by the clinic phone bridge when it hands a call to the agent (only with crm.agente.motor = proprio; 409 «motor_externo» otherwise). Authentication and clinic via the agent secret (X-AX-Segredo or X-AX-Assinatura). Creates the agent request (voice channel, own engine) and returns the greeting with the mandatory AI notice in the call language (the given one, the dialling code one or the Settings one). If the agent cannot answer (switched off, outside its hours or monthly minutes used up), it returns «transferir» (clinic open or extension set) or «terminar» with the unavailability message. Repeating the start of the same call returns the same greeting. Limit: 300 per minute per IP.", "body": { "mode": "raw", "raw": "{\n \"chamada_id\": \"pbx-7f3a-20261029-2214\",\n \"de\": \"+351912345678\",\n \"para\": \"+351210000000\",\n \"gravacao_pedida\": false,\n \"audio_modo\": \"base64\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Own voice engine — one caller turn", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/voz/turno", "host": [ "{{base_url}}" ], "path": [ "ganchos", "voz", "turno" ] }, "description": "The bridge sends each caller turn: WAV audio (base64, up to 8 MB and up to crm.agente.voz_max_segundos) or the text it already transcribed. The server listens (transcription: local service first, external as fallback only with the patient-data switch), checks the clinic alarm signs, requests to speak to a person and limits, answers only from the approved knowledge base and speaks the answer. Actions: «continuar» (play the audio and record the next turn), «transferir» (with destino: department and extension/number) or «terminar» (play and hang up). Alarm sign → urgent task for nursing and «transferir» to the alarm extension. «sequencia» makes the request repeatable: the same sequence returns the same answer without listening again. Turn audio is never stored nor logged. Limits: 1800 per minute per IP; 30 per minute per call.", "body": { "mode": "raw", "raw": "{\n \"chamada_id\": \"pbx-7f3a-20261029-2214\",\n \"sequencia\": 1,\n \"audio_base64\": \"UklGRiQ…\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Endpoint verification (WhatsApp Cloud)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/ganchos/whatsapp", "host": [ "{{base_url}}" ], "path": [ "ganchos", "whatsapp" ], "query": [ { "key": "hub.mode", "value": "", "disabled": true }, { "key": "hub.verify_token", "value": "", "disabled": true }, { "key": "hub.challenge", "value": "", "disabled": true } ] }, "description": "Returns hub.challenge as text when hub.verify_token matches an active clinic's verification code; 403 otherwise.", "auth": { "type": "noauth" } } }, { "name": "Messages and statuses (WhatsApp, Instagram, Messenger)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/ganchos/whatsapp", "host": [ "{{base_url}}" ], "path": [ "ganchos", "whatsapp" ] }, "description": "Meta format. The clinic is resolved from the receiving WhatsApp LINE (metadata.phone_number_id = identifier of an active line; falls back to the number in Settings) or from the page/account (crm.meta.paginas) — never by default. The X-Hub-Signature-256 signature is verified with that clinic's app secret (WhatsApp or crm.meta.app_secret; 401 on failure). Effects: inbox message (the conversation keeps the line and receiving account), new lead for unknown contacts, CONFIRMAR/STOP, photos for review, delivery statuses (WhatsApp «statuses», Messenger «delivery» and «read», Instagram «read»), ad form leads (page → changes[].field = «leadgen»: the lead is read from Meta with the clinic key and created through the funnel), out-of-hours or virtual assistant reply.", "body": { "mode": "raw", "raw": "{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"1029384756\",\n \"changes\": [\n {\n \"field\": \"messages\",\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"351210000000\",\n \"phone_number_id\": \"109876543210\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"Ricardo\"\n },\n \"wa_id\": \"351912345678\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"351912345678\",\n \"id\": \"wamid.HBgM…\",\n \"timestamp\": \"1730107620\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"CONFIRMAR\"\n }\n }\n ]\n }\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } } ] }, { "name": "Indicadores", "item": [ { "name": "Visible groups, catalogue and filter options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/indicadores", "host": [ "{{base_url}}" ], "path": [ "indicadores" ] }, "description": "Only groups allowed by the matrix (indicadores.financeiros|vendas|operacionais|atendimento). 403 if none." } }, { "name": "Indicators of a group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/indicadores/:grupo", "host": [ "{{base_url}}" ], "path": [ "indicadores", ":grupo" ], "query": [ { "key": "indicadores", "value": "leads_origem,conversao", "disabled": true }, { "key": "periodo", "value": "30d", "disabled": true }, { "key": "de", "value": "2026-10-01", "disabled": true }, { "key": "ate", "value": "2026-10-31", "disabled": true }, { "key": "medico_id", "value": "", "disabled": true }, { "key": "comercial_id", "value": "", "disabled": true }, { "key": "origem", "value": "meta", "disabled": true }, { "key": "procedimento_id", "value": "", "disabled": true } ], "variable": [ { "key": "grupo", "value": "vendas" } ] }, "description": "Each indicator comes as blocks: «kpis» (value, previous, % change), «grafico» (series linking to the filtered list) and, when useful, «lista» or «alerta». Indicators whose modules are not yet active come with disponivel=false and the missing list.\n\nDoctors with «own» scope see only their figures. Never clinical content — aggregates only." } }, { "name": "Export the group as CSV", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/indicadores/:grupo/exportar", "host": [ "{{base_url}}" ], "path": [ "indicadores", ":grupo", "exportar" ], "query": [ { "key": "periodo", "value": "30d", "disabled": true }, { "key": "de", "value": "2026-10-01", "disabled": true }, { "key": "ate", "value": "2026-10-31", "disabled": true }, { "key": "medico_id", "value": "", "disabled": true }, { "key": "comercial_id", "value": "", "disabled": true }, { "key": "origem", "value": "meta", "disabled": true }, { "key": "procedimento_id", "value": "", "disabled": true } ], "variable": [ { "key": "grupo", "value": "vendas" } ] }, "description": "CSV with «;» separator, UTF-8 with BOM: indicator, metric, series, x, value, previous, change and unit. Requires «export» on the group module and is audited." } } ] }, { "name": "Integrações", "item": [ { "name": "Operation catalogue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/integracoes/catalogo", "host": [ "{{base_url}}" ], "path": [ "integracoes", "catalogo" ], "query": [ { "key": "lingua", "value": "pt", "disabled": true } ] }, "description": "Every API operation grouped by area, with the required permission, whether integration credentials are accepted and whether it is public, plus the webhook events. Read from the generated specification — never diverges from the code." } }, { "name": "Integration usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/integracoes/consumo", "host": [ "{{base_url}}" ], "path": [ "integracoes", "consumo" ], "query": [ { "key": "dias", "value": "", "disabled": true }, { "key": "cliente", "value": "", "disabled": true } ] }, "description": "Requests per day, errors (HTTP ≥ 400), average duration, latest requests and webhook deliveries, per credential, as §18.1 blocks." } }, { "name": "Integration token (client credentials)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/oauth/token", "host": [ "{{base_url}}" ], "path": [ "oauth", "token" ] }, "description": "RFC 6749 §4.4. Credentials in the body (client_id, client_secret) or HTTP Basic. Standard OAuth response OUTSIDE the envelope. The token is valid for 1 hour; there is no refresh: request a new one. Scopes with clinical content are only granted after the client clinical justification is approved.", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"ax_4f1d0c9b2e7a6f3d8c5b1a20\",\n \"client_secret\": \"…\",\n \"scope\": \"agenda:ver crm.leads:editar\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "OpenAPI 3.1 specification (JSON)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/openapi.json", "host": [ "{{base_url}}" ], "path": [ "openapi.json" ], "query": [ { "key": "lingua", "value": "", "disabled": true }, { "key": "descarregar", "value": "", "disabled": true } ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "OpenAPI 3.1 specification (YAML)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/openapi.yaml", "host": [ "{{base_url}}" ], "path": [ "openapi.yaml" ], "query": [ { "key": "lingua", "value": "", "disabled": true } ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Test collection (Postman 2.1 format)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/postman.json", "host": [ "{{base_url}}" ], "path": [ "postman.json" ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Webhook event catalogue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/webhooks/eventos", "host": [ "{{base_url}}" ], "path": [ "webhooks", "eventos" ] }, "description": "" } }, { "name": "Send a test delivery", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/webhooks/:id/testar", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id", "testar" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Sends the signed «webhook.teste» event now and returns the result (HTTP status, duration, error). Does not count towards the endpoint's consecutive failures." } } ] }, { "name": "A minha licença", "item": [ { "name": "Licence of the current clinic", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licenca", "host": [ "{{base_url}}" ], "path": [ "licenca" ] }, "description": "Plan, modules (included or not), limits and usage, validity, history without internal reasons and renewal contact. Never the full key nor internal notes. In clinic 1: plataforma = true." } }, { "name": "Light licence state (banners)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licenca/estado", "host": [ "{{base_url}}" ], "path": [ "licenca", "estado" ] }, "description": "For any authenticated account (team or patient). Answers even when the licence is blocked, so the app can explain. Patients receive no contract dates." } } ] }, { "name": "Licenças", "item": [ { "name": "List licences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas", "host": [ "{{base_url}}" ], "path": [ "licencas" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[plano]", "value": "", "disabled": true }, { "key": "f[expira]", "value": "", "disabled": true }, { "key": "ordem", "value": "fim:asc", "disabled": true } ] }, "description": "Superadministrators with an active second factor only. Other accounts: 403 so_superadmin (or segundo_fator_necessario)." } }, { "name": "Wizard: create the clinic, the licence and the first administrator", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas", "host": [ "{{base_url}}" ], "path": [ "licencas" ] }, "description": "In one transaction creates (or licenses, with clinica_id) the clinic, the licence with a unique key, the subdomain and own domains, the main site, syncs active modules, prepares profiles, permissions and settings and creates the first administrator. Then runs each module preparation (result per module), stores the logo (≤ 1 MB) and sends the email invitation (single-use link for password and 2FA). Records the «created» event. ", "body": { "mode": "raw", "raw": "{\n \"clinica_id\": null,\n \"clinica\": {\n \"nome\": \"Clínica Capilar Porto\",\n \"nome_legal\": \"Clínica Capilar Porto, Lda.\",\n \"nif\": \"509999990\",\n \"ers_registo\": \"E123456\",\n \"pais\": \"PT\",\n \"morada\": \"Rua da Boavista, 100\",\n \"codigo_postal\": \"4050-110\",\n \"localidade\": \"Porto\",\n \"telefone\": \"+351 220 000 000\",\n \"email\": \"geral@clinicaporto.pt\"\n },\n \"marca\": {\n \"cor_marca\": \"#0E5B4F\",\n \"codigo\": \"PORTO-HAIR\",\n \"subdominio\": \"porto\",\n \"dominio_site\": \"www.clinicaporto.pt\",\n \"dominio_portal\": null\n },\n \"licenca\": {\n \"plano\": \"clinica\",\n \"estado\": \"ativa\",\n \"inicio\": \"2026-10-28\",\n \"fim\": \"2027-10-27\",\n \"dias_graca\": 15,\n \"renovacao_automatica\": true,\n \"modulos\": [\n \"crm.leads\",\n \"agenda\"\n ],\n \"max_utilizadores\": 25,\n \"max_armazenamento_gb\": 500,\n \"max_locais\": 2,\n \"preco\": 590,\n \"periodicidade\": \"mensal\",\n \"moeda\": \"EUR\"\n },\n \"administrador\": {\n \"nome\": \"Joana Pires\",\n \"email\": \"joana@clinicaporto.pt\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a domain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/dominios/:id/apagar", "host": [ "{{base_url}}" ], "path": [ "licencas", "dominios", ":id", "apagar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Make a domain the main one", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/dominios/:id/principal", "host": [ "{{base_url}}" ], "path": [ "licencas", "dominios", ":id", "principal" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Verify a domain (TXT record)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/dominios/:id/verificar", "host": [ "{{base_url}}" ], "path": [ "licencas", "dominios", ":id", "verificar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Plans, licensable modules and defaults", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/planos", "host": [ "{{base_url}}" ], "path": [ "licencas", "planos" ] }, "description": "Each plan's defaults come from the platform settings." } }, { "name": "Possible account managers (active clinic 1 team)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/responsaveis", "host": [ "{{base_url}}" ], "path": [ "licencas", "responsaveis" ] }, "description": "" } }, { "name": "Licence KPIs and charts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/resumo", "host": [ "{{base_url}}" ], "path": [ "licencas", "resumo" ] }, "description": "Active and trial clinics, expiring within 30 days, suspended, monthly recurring revenue, account and storage usage, distribution by state and plan, revenue for the last six months, licences ending and clinics without a licence. " } }, { "name": "Validate a wizard step", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas/validar", "host": [ "{{base_url}}" ], "path": [ "licencas", "validar" ] }, "description": "Step 1 legal data (NIF check digit), 2 brand (unique code and subdomain), 3 licence, 4 administrator, 5 everything. Errors with prefixed field (clinica.nif). Returns code and subdomain suggestions from the name.", "body": { "mode": "raw", "raw": "{\n \"passo\": 1,\n \"clinica\": {\n \"nome\": \"Clínica Capilar Porto\",\n \"nome_legal\": \"Clínica Capilar Porto, Lda.\",\n \"nif\": \"509999990\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Licence detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Includes domains, immutable history and internal notes. Read is audited." } }, { "name": "Cancel (reason required)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Data is kept; access is blocked; auto-renewal is turned off. «cancelled» event." } }, { "name": "Generate a new key", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/chave", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "chave" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Resend the invitation to the first administrator", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/convite", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "convite" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Add a domain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas/:id/dominios", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "dominios" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Subdomains of the base domain are verified; own domains wait for the TXT record «anagensys-verificacao=».", "body": { "mode": "raw", "raw": "{\n \"dominio\": \"www.clinicaporto.pt\",\n \"tipo\": \"site\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enter the clinic (clinic switcher)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/entrar", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "entrar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The choice is bound to the token family (like POST /eu/clinica). Audited and recorded in the licence history." } }, { "name": "Change plan, modules, limits, dates, price and billing", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas/:id/plano", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "plano" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Syncs the clinic active modules (modules outside the licence disappear from the menu and are refused by the server). «changed» event with before/after.", "body": { "mode": "raw", "raw": "{\n \"plano\": \"grupo\",\n \"modulos\": [\n \"crm.leads\",\n \"agenda\",\n \"bloco.mapa\"\n ],\n \"max_utilizadores\": 80,\n \"max_armazenamento_gb\": 2000,\n \"max_locais\": 10,\n \"preco\": 1490,\n \"periodicidade\": \"mensal\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Repeat the clinic preparation (idempotent)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/preparar", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "preparar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Reactivate a suspended or cancelled licence", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/licencas/:id/reativar", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Renew", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas/:id/renovar", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "renovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Without «fim», adds a period (monthly/yearly) to the current end or to today if past. Expired becomes active; suspended stays suspended; cancelled is refused. «renewed» event.", "body": { "mode": "raw", "raw": "{\n \"periodo\": \"anual\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Suspend (reason required)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/licencas/:id/suspender", "host": [ "{{base_url}}" ], "path": [ "licencas", ":id", "suspender" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Immediate block of the clinic team, portal and API (403 licenca_suspensa). Emails the clinic administration, without the internal reason. «suspended» event.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Faturas de setembro e outubro por pagar.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Campanhas de marketing", "item": [ { "name": "Campaign editor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Campaign, blocks, images usable on the channel, segments, warnings (prices without VAT, result guarantees), legal footer and permissions. Also available to the clinical board without marketing permission, to approve." } }, { "name": "Save the campaign", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft only (409 otherwise). Blocks validated: sanitised HTML, https/mailto/tel links, library images with consent valid for the channel (422 with the reason). SMS and WhatsApp campaigns use «conteudo» (up to 640 characters for SMS).", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Novidades de outono\",\n \"canal\": \"email\",\n \"tipo\": \"novidade\",\n \"finalidade\": \"marketing\",\n \"segmento_id\": 3,\n \"assunto\": \"Novidades na clínica este outono\",\n \"pre_cabecalho\": \"Novo horário ao sábado\",\n \"blocos\": [\n {\n \"tipo\": \"titulo\",\n \"texto\": \"Abrimos ao sábado\"\n },\n {\n \"tipo\": \"texto\",\n \"html\": \"

A partir de novembro, a clínica recebe consultas de avaliação ao sábado de manhã.

\"\n },\n {\n \"tipo\": \"imagem\",\n \"imagem_id\": 5,\n \"legenda\": \"A nossa receção\"\n },\n {\n \"tipo\": \"botao\",\n \"texto\": \"Marcar avaliação\",\n \"url\": \"https://clinica.exemplo.pt/marcar\"\n },\n {\n \"tipo\": \"divisoria\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Schedule sending", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/agendar", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "agendar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Approved only and with the same approved content (409 otherwise). Sending is done in batches by the scheduler, within allowed hours, archiving the content sent. Effects: campanha.enviada webhook at the end.", "body": { "mode": "raw", "raw": "{\n \"agendada_para\": \"2026-11-03T10:00:00+00:00\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve or return (clinical board)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/aprovar", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Clinical board only (403 for others). Returning requires a note. Effects: notification to the requester, «approve» audit.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"aprovar\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel the campaign", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Until sending ends; pending sends are marked as not sent («cancelada»)." } }, { "name": "Count who can receive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/contar", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "contar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Recalculates the segment and applies, contact by contact, the sending rules (consent or customer exception, opt-out list, contact for the channel, double opt-in, explicit consent when the segment uses clinical data)." } }, { "name": "Campaign statistics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/estatisticas", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "estatisticas" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Request clinical approval", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/pedir-aprovacao", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "pedir-aprovacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only a draft with content and segment. Stores the content fingerprint; any later change requires a new approval. Effects: notification to the clinical board." } }, { "name": "Preview (without saving)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/pre-visualizar", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "pre-visualizar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Renders the message as the contact receives it, with the legal footer and unsubscribe link, from the posted draft (or the saved one).", "body": { "mode": "raw", "raw": "{\n \"rascunho\": {\n \"assunto\": \"Novidades na clínica este outono\",\n \"blocos\": [\n {\n \"tipo\": \"titulo\",\n \"texto\": \"Abrimos ao sábado\"\n },\n {\n \"tipo\": \"texto\",\n \"html\": \"

A partir de novembro, a clínica recebe consultas de avaliação ao sábado de manhã.

\"\n },\n {\n \"tipo\": \"imagem\",\n \"imagem_id\": 5,\n \"legenda\": \"A nossa receção\"\n },\n {\n \"tipo\": \"botao\",\n \"texto\": \"Marcar avaliação\",\n \"url\": \"https://clinica.exemplo.pt/marcar\"\n },\n {\n \"tipo\": \"divisoria\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send a test email to me", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/campanhas/:id/teste", "host": [ "{{base_url}}" ], "path": [ "marketing", "campanhas", ":id", "teste" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Email campaigns only; the test goes to the caller's email. Limit: 10 per 10 minutes." } } ] }, { "name": "Resultados de marketing", "item": [ { "name": "Conversions for ad platforms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/conversoes", "host": [ "{{base_url}}" ], "path": [ "marketing", "conversoes" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Leads with a click identifier that reached booked consultation, booked surgery or won, for the clinic to send back to ad platforms. Empty list when the option is off in Settings (legal basis required). No personal data: only the click identifier." } }, { "name": "Import ad costs (CSV)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/marketing/custos/importar", "host": [ "{{base_url}}" ], "path": [ "marketing", "custos", "importar" ] }, "description": "CSV file («ficheiro» field, up to 5 MB, type checked from content) or the text in «csv». Required columns: plataforma, campanha, data, custo; optional: impressoes, cliques, leads. Comma or semicolon separator; comma or dot decimals. The same platform + campaign + date updates the existing row. Limit: 20 per 10 minutes.", "body": { "mode": "raw", "raw": "{\n \"csv\": \"plataforma;campanha;data;custo;impressoes;cliques;leads\\nmeta;capilar-outono;2026-10-27;84,50;6100;102;3\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Channels and integrations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/integracoes", "host": [ "{{base_url}}" ], "path": [ "marketing", "integracoes" ] }, "description": "Status of each connection (ad leads, Instagram and Messenger, WhatsApp lines, conversions, costs, audiences, special dates, email platform, opens), what is missing in Settings, receiving addresses, latest received leads and the conversions queue. Same data as the web screen." } }, { "name": "Manual integration action", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/integracoes/:acao", "host": [ "{{base_url}}" ], "path": [ "marketing", "integracoes", ":acao" ], "variable": [ { "key": "acao", "value": "1" } ] }, "description": "meta_testar, meta_subscrever (admin.definicoes edit), google_testar, leads_reprocessar (crm.leads edit), conversoes_enviar, custos_sincronizar (body: dias ≤ 90), email_sincronizar, email_testar, publico_enviar (body: id), datas_processar — the others require marketing edit. Audited. Limit: 30 per 10 minutes." } }, { "name": "Export an ad audience (CSV)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/publicos/:id/exportar", "host": [ "{{base_url}}" ], "path": [ "marketing", "publicos", ":id", "exportar" ], "query": [ { "key": "formato", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only people with explicit marketing consent, not on the objection list; email, phone, first and last name as normalised SHA-256 hashes. Audited. Limit: 20 per 10 minutes." } }, { "name": "Costs and results per campaign", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/marketing/resultados", "host": [ "{{base_url}}" ], "path": [ "marketing", "resultados" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Matches imported spend with real leads (by campaign or utm_campaign) and with the booked consultation and surgery stages. Last 90 days by default." } } ] }, { "name": "Modelos de IA", "item": [ { "name": "Status and choices per use", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/estado", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "estado" ] }, "description": "Per use: label, description, area, applicable fields, resolved values with their origin (setting | server default), switches and pode_editar. Only clinic 1 staff with Settings › Edit can change." } }, { "name": "Save choices for a use", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/guardar", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "guardar" ] }, "description": "Unknown use → 422. Only the fields applicable to the use are accepted." } }, { "name": "Models installed on the local service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/ollama", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "ollama" ], "query": [ { "key": "renovar", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Models available on the external service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/openrouter", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "openrouter" ], "query": [ { "key": "q", "value": "", "disabled": true }, { "key": "limite", "value": "", "disabled": true }, { "key": "renovar", "value": "", "disabled": true }, { "key": "tipo", "value": "", "disabled": true } ] }, "description": "Without «tipo», the text models (price per million tokens, images); with tipo=transcricao or tipo=fala, the audio models (with voices, when the catalogue lists them); with tipo=imagem, the models with image output (output_modalities=image)." } }, { "name": "Reset a field to the server value", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/repor", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "repor" ] }, "description": "" } }, { "name": "Test a model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos-ia/testar", "host": [ "{{base_url}}" ], "path": [ "modelos-ia", "testar" ] }, "description": "For speech targets, says the test phrase in the requested language (with the given voice or the Settings one) and, if the use has a transcription model, listens to it back; for transcription targets, listens to the phrase said by the use speech model; for image targets, generates a 256 px blue square. Tests carry no patient data." } } ] }, { "name": "Visualizador 3D", "item": [ { "name": "Active embed codes of the integration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos3d/incorporacoes", "host": [ "{{base_url}}" ], "path": [ "modelos3d", "incorporacoes" ], "query": [ { "key": "modelo3d_id", "value": "", "disabled": true } ] }, "description": "Without the code (only its hash is stored)." } }, { "name": "Embed code state (views, validity)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos3d/incorporacoes/:id", "host": [ "{{base_url}}" ], "path": [ "modelos3d", "incorporacoes", ":id" ], "variable": [ { "key": "id", "value": "33" } ] }, "description": "" } }, { "name": "Revoke the embed code", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/modelos3d/incorporacoes/:id", "host": [ "{{base_url}}" ], "path": [ "modelos3d", "incorporacoes", ":id" ], "variable": [ { "key": "id", "value": "33" } ] }, "description": "Also revokes the temporary model share; the page then answers 410." } }, { "name": "Request the embed code for a 3D model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/modelos3d/:id/incorporacao", "host": [ "{{base_url}}" ], "path": [ "modelos3d", ":id", "incorporacao" ], "variable": [ { "key": "id", "value": "33" } ] }, "description": "Integration clients only (team and patient tokens get 403). Requested «origens» must be among the integration's authorised origins; without «origens», all authorised origins apply. No authorised origins → 422.", "body": { "mode": "raw", "raw": "{\n \"minutos\": 120,\n \"origens\": [\n \"https://parceiro.exemplo.com\"\n ],\n \"referencia\": \"consulta-remota-881\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Motor de cálculo", "item": [ { "name": "Parameter catalogue (section 5)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/catalogo", "host": [ "{{base_url}}" ], "path": [ "motor", "catalogo" ] }, "description": "" } }, { "name": "Analysis example with a version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/motor/experimentar", "host": [ "{{base_url}}" ], "path": [ "motor", "experimentar" ] }, "description": "With the initial suggestions it gives 5,625 / 50 FU/cm² / 4,750 / 2,850 / 1,900 / −875.", "body": { "mode": "raw", "raw": "{\n \"versao_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Parameter versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/versoes", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes" ] }, "description": "" } }, { "name": "New draft", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/motor/versoes", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes" ] }, "description": "From a version (base_id), the version in force or the analysis initial suggestions.", "body": { "mode": "raw", "raw": "{\n \"base_id\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Full version (table, scenarios, zone × grade table, differences)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/versoes/:id", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Save the draft", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/motor/versoes/:id", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Drafts only. Each parameter's unit is the catalogue's (another → 422).", "body": { "mode": "raw", "raw": "{\n \"parametros\": {\n \"valores\": {\n \"dens_coroa\": {\n \"valor\": 22\n }\n },\n \"cenarios\": {\n \"agressivo\": {\n \"extracao_sessao_pct\": 30\n }\n }\n },\n \"finalidade_regulamentar\": \"Apoio ao médico…\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve (clinical board only)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/versoes/:id/aprovar", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes", ":id", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires a doctor with direcao_clinica = 1 and «approve» on clinico.parametros, and a written regulatory purpose. The previous version in force is archived. Effects: notification to doctors, motor.versao_aprovada webhook." } }, { "name": "Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/motor/versoes/:id/arquivar", "host": [ "{{base_url}}" ], "path": [ "motor", "versoes", ":id", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Withdrawing the version in force requires the clinical board." } } ] }, { "name": "Recurso: Certificates", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/academia_certificados", "host": [ "{{base_url}}" ], "path": [ "opcoes", "academia_certificados" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Certificates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_certificados", "host": [ "{{base_url}}" ], "path": [ "r", "academia_certificados" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[curso_id]", "value": "", "disabled": true }, { "key": "f[emitido_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Certificates» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_certificados/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "academia_certificados", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Certificate", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_certificados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_certificados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Revoke", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_certificados/:id/acao/revogar", "host": [ "{{base_url}}" ], "path": [ "r", "academia_certificados", ":id", "acao", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Academy courses", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/academia_cursos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "academia_cursos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Academy courses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos" ], "query": [ { "key": "f[categoria]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Course", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Academy courses» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Course", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Course", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_cursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_cursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Lessons", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/academia_licoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "academia_licoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Lessons", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes" ], "query": [ { "key": "f[curso_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Lesson", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Lessons» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Lesson", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Lesson", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_licoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_licoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Training paths", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/academia_percursos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "academia_percursos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Training paths", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos" ], "query": [ { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Path", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Training paths» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Path", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Path", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_percursos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_percursos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Test questions", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/academia_perguntas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "academia_perguntas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Test questions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas" ], "query": [ { "key": "f[curso_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Question", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Test questions» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Question", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Question", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/academia_perguntas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "academia_perguntas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Emergency access", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/acessos_emergencia", "host": [ "{{base_url}}" ], "path": [ "opcoes", "acessos_emergencia" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Emergency access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/acessos_emergencia", "host": [ "{{base_url}}" ], "path": [ "r", "acessos_emergencia" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[decisao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Emergency access» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/acessos_emergencia/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "acessos_emergencia", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Emergency access", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/acessos_emergencia/:id", "host": [ "{{base_url}}" ], "path": [ "r", "acessos_emergencia", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/acessos_emergencia/:id/acao/rever", "host": [ "{{base_url}}" ], "path": [ "r", "acessos_emergencia", ":id", "acao", "rever" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: End now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/acessos_emergencia/:id/acao/terminar", "host": [ "{{base_url}}" ], "path": [ "r", "acessos_emergencia", ":id", "acao", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Agent requests", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/agente_pedidos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "agente_pedidos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Agent requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_pedidos", "host": [ "{{base_url}}" ], "path": [ "r", "agente_pedidos" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[sinal_alarme]", "value": "", "disabled": true }, { "key": "f[amostra]", "value": "", "disabled": true }, { "key": "f[revisao_estado]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Agent requests» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_pedidos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "agente_pedidos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Agent request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "agente_pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Create test conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_pedidos/:id/acao/teste", "host": [ "{{base_url}}" ], "path": [ "r", "agente_pedidos", ":id", "acao", "teste" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Test conversations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/agente_testes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "agente_testes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Test conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Test conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Test conversations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Test conversation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Test conversation", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/agente_testes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "agente_testes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Access alerts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/alertas_acesso", "host": [ "{{base_url}}" ], "path": [ "opcoes", "alertas_acesso" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Access alerts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/alertas_acesso", "host": [ "{{base_url}}" ], "path": [ "r", "alertas_acesso" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[gravidade]", "value": "", "disabled": true }, { "key": "f[detetado_em]", "value": "", "disabled": true }, { "key": "f[decisao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Access alerts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/alertas_acesso/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "alertas_acesso", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Access alert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/alertas_acesso/:id", "host": [ "{{base_url}}" ], "path": [ "r", "alertas_acesso", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Detect now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/alertas_acesso/:id/acao/detetar_agora", "host": [ "{{base_url}}" ], "path": [ "r", "alertas_acesso", ":id", "acao", "detetar_agora" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/alertas_acesso/:id/acao/rever", "host": [ "{{base_url}}" ], "path": [ "r", "alertas_acesso", ":id", "acao", "rever" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Integration clients", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/api_clientes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "api_clientes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Integration clients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes" ], "query": [ { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Integration client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Integration clients» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Integration client", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Integration client", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve clinical justification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id/acao/aprovar_justificacao", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id", "acao", "aprovar_justificacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Revoke", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id/acao/revogar", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id", "acao", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Rotate secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/api_clientes/:id/acao/rodar_segredo", "host": [ "{{base_url}}" ], "path": [ "r", "api_clientes", ":id", "acao", "rodar_segredo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Items", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/artigos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "artigos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos", "host": [ "{{base_url}}" ], "path": [ "r", "artigos" ], "query": [ { "key": "f[categoria]", "value": "", "disabled": true }, { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos", "host": [ "{{base_url}}" ], "path": [ "r", "artigos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Items» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "artigos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Item", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Record movement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos/:id/acao/movimento", "host": [ "{{base_url}}" ], "path": [ "r", "artigos", ":id", "acao", "movimento" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Supplier prices", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/artigos_precos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "artigos_precos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Supplier prices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos" ], "query": [ { "key": "f[artigo_id]", "value": "", "disabled": true }, { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[preferido]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Supplier price", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Supplier prices» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Supplier price", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Supplier price", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/artigos_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "artigos_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Record of processing activities", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/atividades_tratamento", "host": [ "{{base_url}}" ], "path": [ "opcoes", "atividades_tratamento" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Record of processing activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento" ], "query": [ { "key": "f[base_legal]", "value": "", "disabled": true }, { "key": "f[aipd_estado]", "value": "", "disabled": true }, { "key": "f[dispositivo_medico]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Processing activity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Record of processing activities» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Processing activity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Processing activity", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Mark as reviewed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/atividades_tratamento/:id/acao/marcar_revista", "host": [ "{{base_url}}" ], "path": [ "r", "atividades_tratamento", ":id", "acao", "marcar_revista" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Absences and holidays", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/ausencias", "host": [ "{{base_url}}" ], "path": [ "opcoes", "ausencias" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Absences and holidays", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[recurso_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[inicio]", "value": "", "disabled": true }, { "key": "f[aprovada]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Absence", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Absences and holidays» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Absence", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Absence", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ausencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "ausencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Notices shown", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/avisos_exibicoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "avisos_exibicoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Notices shown", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_exibicoes", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_exibicoes" ], "query": [ { "key": "f[mostrado_em]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[aviso_id]", "value": "", "disabled": true }, { "key": "f[contexto]", "value": "", "disabled": true }, { "key": "f[meio]", "value": "", "disabled": true }, { "key": "f[prova]", "value": "", "disabled": true }, { "key": "f[titular_tipo]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[lead_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Notices shown» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_exibicoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_exibicoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Notice shown", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_exibicoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_exibicoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Privacy notices", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/avisos_privacidade", "host": [ "{{base_url}}" ], "path": [ "opcoes", "avisos_privacidade" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Privacy notices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Privacy notice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Privacy notices» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Privacy notice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Privacy notice", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: New version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/:id/acao/nova_versao", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", ":id", "acao", "nova_versao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Publish", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/avisos_privacidade/:id/acao/publicar", "host": [ "{{base_url}}" ], "path": [ "r", "avisos_privacidade", ":id", "acao", "publicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Knowledge base", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/base_conhecimento", "host": [ "{{base_url}}" ], "path": [ "opcoes", "base_conhecimento" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Knowledge base", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento" ], "query": [ { "key": "f[categoria]", "value": "", "disabled": true }, { "key": "f[publico]", "value": "", "disabled": true }, { "key": "f[clinico]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Article", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Knowledge base» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Article", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Article", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/base_conhecimento/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "base_conhecimento", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Tills", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/caixas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "caixas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Tills", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/caixas", "host": [ "{{base_url}}" ], "path": [ "r", "caixas" ], "query": [ { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[local_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Tills» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/caixas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "caixas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Till", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/caixas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "caixas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Campaigns", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/campanhas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "campanhas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Campaigns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Campaign", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Campaigns» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Campaign", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Campaign", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Call lists", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/campanhas_chamadas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "campanhas_chamadas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Call lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[executor]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Call list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Call lists» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Call list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Call list", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Activate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id/acao/ativar", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id", "acao", "ativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Generate contacts", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id/acao/gerar", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id", "acao", "gerar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Pause", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/campanhas_chamadas/:id/acao/pausar", "host": [ "{{base_url}}" ], "path": [ "r", "campanhas_chamadas", ":id", "acao", "pausar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Captures", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/capturas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "capturas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Captures", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas", "host": [ "{{base_url}}" ], "path": [ "r", "capturas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[qualidade_ok]", "value": "", "disabled": true }, { "key": "f[repetir]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Capture", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas", "host": [ "{{base_url}}" ], "path": [ "r", "capturas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Captures» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "capturas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Capture", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "capturas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Capture", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "capturas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "capturas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Request retake", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/capturas/:id/acao/pedir_repeticao", "host": [ "{{base_url}}" ], "path": [ "r", "capturas", ":id", "acao", "pedir_repeticao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Published cases", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/casos_publicados", "host": [ "{{base_url}}" ], "path": [ "opcoes", "casos_publicados" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Published cases", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados" ], "query": [ { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[publicado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Case", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Published cases» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Case", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Case", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/casos_publicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "casos_publicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Calls", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/chamadas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "chamadas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Calls", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/chamadas", "host": [ "{{base_url}}" ], "path": [ "r", "chamadas" ], "query": [ { "key": "f[direcao]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[inicio]", "value": "", "disabled": true }, { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[resultado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Call", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/chamadas", "host": [ "{{base_url}}" ], "path": [ "r", "chamadas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Calls» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/chamadas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "chamadas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Call", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/chamadas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "chamadas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Call", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/chamadas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "chamadas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } } ] }, { "name": "Recurso: Safety checklists", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/checklist_modelos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "checklist_modelos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Safety checklists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos" ], "query": [ { "key": "f[fase]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Checklist template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Safety checklists» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Checklist template", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Checklist template", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/checklist_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "checklist_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Surgeries", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/cirurgias", "host": [ "{{base_url}}" ], "path": [ "opcoes", "cirurgias" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Surgeries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cirurgias", "host": [ "{{base_url}}" ], "path": [ "r", "cirurgias" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[inicio_previsto]", "value": "", "disabled": true }, { "key": "f[sala_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[aptidao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Surgeries» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cirurgias/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "cirurgias", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Surgery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cirurgias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cirurgias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Clinics", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/clinicas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "clinicas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Clinics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/clinicas", "host": [ "{{base_url}}" ], "path": [ "r", "clinicas" ], "query": [ { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Clinic", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/clinicas", "host": [ "{{base_url}}" ], "path": [ "r", "clinicas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Clinics» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/clinicas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "clinicas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Clinic", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/clinicas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "clinicas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Clinic", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/clinicas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "clinicas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } } ] }, { "name": "Recurso: Website blocks", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/cms_blocos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "cms_blocos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Website blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_blocos", "host": [ "{{base_url}}" ], "path": [ "r", "cms_blocos" ], "query": [ { "key": "f[pagina]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Website blocks» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_blocos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "cms_blocos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Block", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_blocos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cms_blocos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Block", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_blocos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cms_blocos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } } ] }, { "name": "Recurso: Website pages", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/cms_paginas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "cms_paginas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Website pages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas" ], "query": [ { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[publicada]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Page", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Website pages» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Page", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Unpublish", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id/acao/despublicar", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id", "acao", "despublicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id/acao/previsualizar", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id", "acao", "previsualizar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Publish", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cms_paginas/:id/acao/publicar", "host": [ "{{base_url}}" ], "path": [ "r", "cms_paginas", ":id", "acao", "publicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Discount codes", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/codigos_desconto", "host": [ "{{base_url}}" ], "path": [ "opcoes", "codigos_desconto" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Discount codes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[valido_ate]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Discount code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Discount codes» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Discount code", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Discount code", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/codigos_desconto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "codigos_desconto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Commissions", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/comissoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "comissoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Commissions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[proposta_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[vence_em]", "value": "", "disabled": true }, { "key": "f[paga_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Commission", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Commissions» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Commission", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Commission", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Reverse", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes/:id/acao/estornar", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes", ":id", "acao", "estornar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as paid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes/:id/acao/marcar_paga", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes", ":id", "acao", "marcar_paga" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Commission rules", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/comissoes_regras", "host": [ "{{base_url}}" ], "path": [ "opcoes", "comissoes_regras" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Commission rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Commission rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Commission rules» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Commission rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Commission rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comissoes_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comissoes_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Complications", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/complicacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "complicacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Complications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[gravidade]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[recall]", "value": "", "disabled": true }, { "key": "f[recall_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Complication", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Complications» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Complication", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Complication", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Reopen", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes/:id/acao/reabrir", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes", ":id", "acao", "reabrir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as resolved", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/complicacoes/:id/acao/resolver", "host": [ "{{base_url}}" ], "path": [ "r", "complicacoes", ":id", "acao", "resolver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Announcements", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/comunicados", "host": [ "{{base_url}}" ], "path": [ "opcoes", "comunicados" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Announcements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados" ], "query": [ { "key": "f[publico]", "value": "", "disabled": true }, { "key": "f[publicado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Announcement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Announcements» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Announcement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Announcement", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: I have read and understood", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/:id/acao/confirmar", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", ":id", "acao", "confirmar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Remind those who have not read it", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/comunicados/:id/acao/lembrar", "host": [ "{{base_url}}" ], "path": [ "r", "comunicados", ":id", "acao", "lembrar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Consent templates", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/consentimento_modelos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "consentimento_modelos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Consent templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos" ], "query": [ { "key": "f[finalidade]", "value": "", "disabled": true }, { "key": "f[base_legal]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Consent template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Consent templates» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Consent template", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Consent template", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: New version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimento_modelos/:id/acao/nova_versao", "host": [ "{{base_url}}" ], "path": [ "r", "consentimento_modelos", ":id", "acao", "nova_versao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Consent register", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/consentimentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "consentimentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Consent register", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimentos", "host": [ "{{base_url}}" ], "path": [ "r", "consentimentos" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[finalidade]", "value": "", "disabled": true }, { "key": "f[decisao]", "value": "", "disabled": true }, { "key": "f[modelo_id]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[recolhido_por]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Consent register» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "consentimentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Consent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consentimentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Export evidence", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimentos/:id/acao/exportar_prova", "host": [ "{{base_url}}" ], "path": [ "r", "consentimentos", ":id", "acao", "exportar_prova" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Withdraw consent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consentimentos/:id/acao/revogar", "host": [ "{{base_url}}" ], "path": [ "r", "consentimentos", ":id", "acao", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Retention periods", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/conservacao_regras", "host": [ "{{base_url}}" ], "path": [ "opcoes", "conservacao_regras" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Retention periods", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras" ], "query": [ { "key": "f[categoria]", "value": "", "disabled": true }, { "key": "f[acao]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Retention rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Retention periods» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Retention rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Retention rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Run now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conservacao_regras/:id/acao/executar_agora", "host": [ "{{base_url}}" ], "path": [ "r", "conservacao_regras", ":id", "acao", "executar_agora" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Consultations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/consultas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "consultas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Consultations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consultas", "host": [ "{{base_url}}" ], "path": [ "r", "consultas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[medico_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[elegibilidade]", "value": "", "disabled": true }, { "key": "f[escala]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[viabilidade]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Schema of «Consultations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consultas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "consultas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Consultation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consultas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/consultas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "consultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Paying accounts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/contas_pagadoras", "host": [ "{{base_url}}" ], "path": [ "opcoes", "contas_pagadoras" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Paying accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[localidade]", "value": "", "disabled": true }, { "key": "f[entidade_publica]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Paying account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Paying accounts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Paying account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Paying account", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_pagadoras/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_pagadoras", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Sub-accounts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/contas_subcontas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "contas_subcontas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Sub-accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas" ], "query": [ { "key": "f[conta_id]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Sub-account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Sub-accounts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Sub-account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Sub-account", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/contas_subcontas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "contas_subcontas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Agreements", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/convencoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "convencoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Agreements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[conta_id]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Agreement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Agreements» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Agreement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Agreement", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Agreement procedures", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/convencoes_atos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "convencoes_atos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Agreement procedures", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos" ], "query": [ { "key": "f[convencao_id]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Agreement procedure", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Agreement procedures» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Agreement procedure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Agreement procedure", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/convencoes_atos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "convencoes_atos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Conversations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/conversas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "conversas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conversas", "host": [ "{{base_url}}" ], "path": [ "r", "conversas" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[departamento]", "value": "", "disabled": true }, { "key": "f[atribuida_a]", "value": "", "disabled": true }, { "key": "f[ia_a_tratar]", "value": "", "disabled": true }, { "key": "f[ultima_mensagem_em]", "value": "", "disabled": true }, { "key": "f[avaliacao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Conversations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conversas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "conversas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Conversation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conversas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "conversas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Conversation", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/conversas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "conversas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } } ] }, { "name": "Recurso: Care by stage", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/cuidados_conteudos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "cuidados_conteudos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Care by stage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Care content", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Care by stage» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Care content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Care content", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Return for review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id/acao/devolver", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id", "acao", "devolver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Withdraw", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id/acao/retirar", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id", "acao", "retirar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Send for approval", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/cuidados_conteudos/:id/acao/submeter", "host": [ "{{base_url}}" ], "path": [ "r", "cuidados_conteudos", ":id", "acao", "submeter" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Ad costs", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/custos_anuncios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "custos_anuncios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Ad costs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios" ], "query": [ { "key": "f[plataforma]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Ad cost", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Ad costs» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Ad cost", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Ad cost", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/custos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "custos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Special dates", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/datas_especiais", "host": [ "{{base_url}}" ], "path": [ "opcoes", "datas_especiais" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Special dates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Special date", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Special dates» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Special date", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Special date", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Run today", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/datas_especiais/:id/acao/processar", "host": [ "{{base_url}}" ], "path": [ "r", "datas_especiais", ":id", "acao", "processar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Delegations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/delegacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "delegacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Delegations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes" ], "query": [ { "key": "f[de_utilizador_id]", "value": "", "disabled": true }, { "key": "f[para_utilizador_id]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Delegation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Delegations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Delegation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Delegation", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: End", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/delegacoes/:id/acao/terminar", "host": [ "{{base_url}}" ], "path": [ "r", "delegacoes", ":id", "acao", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Support diagnoses", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/diagnosticos_apoio", "host": [ "{{base_url}}" ], "path": [ "opcoes", "diagnosticos_apoio" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Support diagnoses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Support diagnosis", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Support diagnoses» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Support diagnosis", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Support diagnosis", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Activate / deactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id/acao/alternar", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id", "acao", "alternar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: aprovar." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/diagnosticos_apoio/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "diagnosticos_apoio", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Document templates", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/documento_modelos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "documento_modelos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Document templates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Document template", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Document templates» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Document template", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Document template", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Issue document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id/acao/emitir", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id", "acao", "emitir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: New version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documento_modelos/:id/acao/nova_versao", "host": [ "{{base_url}}" ], "path": [ "r", "documento_modelos", ":id", "acao", "nova_versao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Issued documents", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/documentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "documentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Issued documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos", "host": [ "{{base_url}}" ], "path": [ "r", "documentos" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[modelo_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[assinatura_tipo]", "value": "", "disabled": true }, { "key": "f[partilhado_paciente]", "value": "", "disabled": true }, { "key": "f[assinado_em]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Issued documents» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "documentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "documentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Void", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos/:id/acao/anular", "host": [ "{{base_url}}" ], "path": [ "r", "documentos", ":id", "acao", "anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Remove from the portal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos/:id/acao/deixar_partilhar", "host": [ "{{base_url}}" ], "path": [ "r", "documentos", ":id", "acao", "deixar_partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Share on the portal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos/:id/acao/partilhar", "host": [ "{{base_url}}" ], "path": [ "r", "documentos", ":id", "acao", "partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Tax documents", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/documentos_fiscais", "host": [ "{{base_url}}" ], "path": [ "opcoes", "documentos_fiscais" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Tax documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[emitido_em]", "value": "", "disabled": true }, { "key": "f[conta_id]", "value": "", "disabled": true }, { "key": "f[eletronica_estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Tax documents» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Tax document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Send to patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id/acao/enviar_paciente", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id", "acao", "enviar_paciente" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Issue credit note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id/acao/nota_credito", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id", "acao", "nota_credito" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Try issuing again", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id/acao/reemitir", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id", "acao", "reemitir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Record e-invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id/acao/registar_eletronica", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id", "acao", "registar_eletronica" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Record issue", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/documentos_fiscais/:id/acao/registar_emissao", "host": [ "{{base_url}}" ], "path": [ "r", "documentos_fiscais", ":id", "acao", "registar_emissao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Orders", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/encomendas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "encomendas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas" ], "query": [ { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Orders» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Order", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id/acao/cancelar", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id", "acao", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Send to supplier", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id/acao/enviar", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id", "acao", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Receive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/encomendas/:id/acao/receber", "host": [ "{{base_url}}" ], "path": [ "r", "encomendas", ":id", "acao", "receber" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Episodes", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/episodios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "episodios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Episodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios", "host": [ "{{base_url}}" ], "path": [ "r", "episodios" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[area]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[medico_id]", "value": "", "disabled": true }, { "key": "f[aberto_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Episode", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios", "host": [ "{{base_url}}" ], "path": [ "r", "episodios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Episodes» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Episode", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Episode", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Add to team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/:id/acao/adicionar_equipa", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", ":id", "acao", "adicionar_equipa" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Change status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios/:id/acao/mudar_estado", "host": [ "{{base_url}}" ], "path": [ "r", "episodios", ":id", "acao", "mudar_estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Episode teams", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/episodios_equipa", "host": [ "{{base_url}}" ], "path": [ "opcoes", "episodios_equipa" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Episode teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa" ], "query": [ { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[papel]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Team membership", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Episode teams» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Team membership", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Team membership", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa/:id", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: End membership", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/episodios_equipa/:id/acao/terminar", "host": [ "{{base_url}}" ], "path": [ "r", "episodios_equipa", ":id", "acao", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Equipment", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/equipamentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "equipamentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Equipment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos" ], "query": [ { "key": "f[dispositivo_medico]", "value": "", "disabled": true }, { "key": "f[classe]", "value": "", "disabled": true }, { "key": "f[localizacao]", "value": "", "disabled": true }, { "key": "f[proxima_manutencao]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Equipment item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Equipment» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Equipment item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Equipment item", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Record maintenance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos/:id/acao/registar_manutencao", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos", ":id", "acao", "registar_manutencao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Maintenance and records", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/equipamentos_registos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "equipamentos_registos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Maintenance and records", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos" ], "query": [ { "key": "f[equipamento_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Equipment record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Maintenance and records» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Equipment record", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Equipment record", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipamentos_registos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipamentos_registos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Teams", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/equipas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "equipas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Teams", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas", "host": [ "{{base_url}}" ], "path": [ "r", "equipas" ], "query": [ { "key": "f[departamento]", "value": "", "disabled": true }, { "key": "f[chefe_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas", "host": [ "{{base_url}}" ], "path": [ "r", "equipas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Teams» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "equipas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Team", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/equipas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "equipas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Public holidays", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/feriados", "host": [ "{{base_url}}" ], "path": [ "opcoes", "feriados" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Public holidays", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados", "host": [ "{{base_url}}" ], "path": [ "r", "feriados" ], "query": [ { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[ambito]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Public holiday", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados", "host": [ "{{base_url}}" ], "path": [ "r", "feriados" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Public holidays» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "feriados", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Public holiday", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "feriados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Public holiday", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "feriados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/feriados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "feriados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Team training", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/formacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "formacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Team training", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[tema]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[validade_ate]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Training", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Team training» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Training", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Training", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Forms", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/formularios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "formularios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Forms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios", "host": [ "{{base_url}}" ], "path": [ "r", "formularios" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true }, { "key": "f[modelo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios", "host": [ "{{base_url}}" ], "path": [ "r", "formularios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Forms» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Form", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Activate / deactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id/acao/alternar", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id", "acao", "alternar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Duplicate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id/acao/duplicar", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id", "acao", "duplicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Request form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id/acao/pedir", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id", "acao", "pedir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Translate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios/:id/acao/traduzir", "host": [ "{{base_url}}" ], "path": [ "r", "formularios", ":id", "acao", "traduzir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Form responses", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/formularios_respostas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "formularios_respostas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Form responses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas" ], "query": [ { "key": "f[formulario_id]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[alarme]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[preenchido_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Schema of «Form responses» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Form response", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Return to patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas/:id/acao/devolver", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas", ":id", "acao", "devolver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas/:id/acao/rejeitar", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas", ":id", "acao", "rejeitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Validate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/formularios_respostas/:id/acao/validar", "host": [ "{{base_url}}" ], "path": [ "r", "formularios_respostas", ":id", "acao", "validar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Photographs", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/fotos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "fotos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Photographs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos", "host": [ "{{base_url}}" ], "path": [ "r", "fotos" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[vista]", "value": "", "disabled": true }, { "key": "f[zona]", "value": "", "disabled": true }, { "key": "f[album]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[partilhada_paciente]", "value": "", "disabled": true }, { "key": "f[qualidade_ok]", "value": "", "disabled": true }, { "key": "f[rosto_desfocado]", "value": "", "disabled": true }, { "key": "f[simulacao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Photograph", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos", "host": [ "{{base_url}}" ], "path": [ "r", "fotos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Photographs» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Photograph", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Photograph", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Accept", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id/acao/aceitar", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id", "acao", "aceitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Stop sharing", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id/acao/deixar_partilhar", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id", "acao", "deixar_partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Share with the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id/acao/partilhar", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id", "acao", "partilhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reject", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/fotos/:id/acao/rejeitar", "host": [ "{{base_url}}" ], "path": [ "r", "fotos", ":id", "acao", "rejeitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Pipeline stages", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/funil_fases", "host": [ "{{base_url}}" ], "path": [ "opcoes", "funil_fases" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Pipeline stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases" ], "query": [ { "key": "f[funil_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Pipeline stage", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Pipeline stages» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Pipeline stage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Pipeline stage", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funil_fases/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funil_fases", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Market funnels", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/funis", "host": [ "{{base_url}}" ], "path": [ "opcoes", "funis" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Market funnels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis", "host": [ "{{base_url}}" ], "path": [ "r", "funis" ], "query": [ { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Funnel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis", "host": [ "{{base_url}}" ], "path": [ "r", "funis" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Market funnels» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "funis", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Funnel", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Funnel", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis/:id", "host": [ "{{base_url}}" ], "path": [ "r", "funis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Create stages from the main funnel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/funis/:id/acao/criar_fases", "host": [ "{{base_url}}" ], "path": [ "r", "funis", ":id", "acao", "criar_fases" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Call scripts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/guioes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "guioes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Call scripts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes", "host": [ "{{base_url}}" ], "path": [ "r", "guioes" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[finalidade]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Call script", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes", "host": [ "{{base_url}}" ], "path": [ "r", "guioes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Call scripts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "guioes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Call script", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "guioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Call script", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "guioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/guioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "guioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Fees", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/honorarios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "honorarios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Fees", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[data_ato]", "value": "", "disabled": true }, { "key": "f[cirurgia_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Fee", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Fees» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Fee", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Fee", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Mark as paid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/honorarios/:id/acao/marcar_pago", "host": [ "{{base_url}}" ], "path": [ "r", "honorarios", ":id", "acao", "marcar_pago" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Working hours", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/horarios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "horarios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Working hours", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios", "host": [ "{{base_url}}" ], "path": [ "r", "horarios" ], "query": [ { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[recurso_id]", "value": "", "disabled": true }, { "key": "f[dia_semana]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Working hours", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios", "host": [ "{{base_url}}" ], "path": [ "r", "horarios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Working hours» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "horarios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Working hours", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "horarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Working hours", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "horarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/horarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "horarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: AI requests", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/ia_pedidos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "ia_pedidos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List AI requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_pedidos", "host": [ "{{base_url}}" ], "path": [ "r", "ia_pedidos" ], "query": [ { "key": "f[tarefa]", "value": "", "disabled": true }, { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[utilizador_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «AI requests» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_pedidos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "ia_pedidos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get AI request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "ia_pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: AI proposals", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/ia_propostas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "ia_propostas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List AI proposals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[consulta_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[modelo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[decidido_por]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Schema of «AI proposals» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get AI proposal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Accept", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas/:id/acao/aceitar", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas", ":id", "acao", "aceitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Correct", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas/:id/acao/corrigir", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas", ":id", "acao", "corrigir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Decline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/ia_propostas/:id/acao/recusar", "host": [ "{{base_url}}" ], "path": [ "r", "ia_propostas", ":id", "acao", "recusar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Image library", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/imagens_marketing", "host": [ "{{base_url}}" ], "path": [ "opcoes", "imagens_marketing" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Image library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Image library» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Image", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing/:id", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Image", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing/:id", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing/:id", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Withdraw", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/imagens_marketing/:id/acao/retirar", "host": [ "{{base_url}}" ], "path": [ "r", "imagens_marketing", ":id", "acao", "retirar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Imports", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/importacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "importacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Imports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/importacoes", "host": [ "{{base_url}}" ], "path": [ "r", "importacoes" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Imports» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/importacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "importacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Import", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/importacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "importacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Security incidents", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/incidentes_seguranca", "host": [ "{{base_url}}" ], "path": [ "opcoes", "incidentes_seguranca" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Security incidents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca" ], "query": [ { "key": "f[gravidade]", "value": "", "disabled": true }, { "key": "f[risco]", "value": "", "disabled": true }, { "key": "f[detetado_em]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Incident", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Security incidents» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Incident", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Incident", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Close", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id/acao/encerrar", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id", "acao", "encerrar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Record notification to the CNPD", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id/acao/notificar_cnpd", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id", "acao", "notificar_cnpd" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Record information to data subjects", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/incidentes_seguranca/:id/acao/notificar_titulares", "host": [ "{{base_url}}" ], "path": [ "r", "incidentes_seguranca", ":id", "acao", "notificar_titulares" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Itineraries", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/itinerarios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "itinerarios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Itineraries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[chegada]", "value": "", "disabled": true }, { "key": "f[interprete_idioma]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Itinerary", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Itineraries» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Itinerary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Itinerary", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/itinerarios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "itinerarios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Leads", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/leads", "host": [ "{{base_url}}" ], "path": [ "opcoes", "leads" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Leads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads", "host": [ "{{base_url}}" ], "path": [ "r", "leads" ], "query": [ { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[campanha]", "value": "", "disabled": true }, { "key": "f[funil_id]", "value": "", "disabled": true }, { "key": "f[fase_id]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true }, { "key": "f[decisao]", "value": "", "disabled": true }, { "key": "f[motivo_perda]", "value": "", "disabled": true }, { "key": "f[duplicado_de]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Lead", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads", "host": [ "{{base_url}}" ], "path": [ "r", "leads" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Leads» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "leads", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Lead", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Lead", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Convert into patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id/acao/converter", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id", "acao", "converter" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Merge with…", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id/acao/fundir", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id", "acao", "fundir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as lost", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id/acao/marcar_perdido", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id", "acao", "marcar_perdido" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Request opt-in to communications", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/leads/:id/acao/pedir_adesao", "host": [ "{{base_url}}" ], "path": [ "r", "leads", ":id", "acao", "pedir_adesao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Waiting list", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/lista_espera", "host": [ "{{base_url}}" ], "path": [ "opcoes", "lista_espera" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Waiting list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo_id]", "value": "", "disabled": true }, { "key": "f[profissional_id]", "value": "", "disabled": true }, { "key": "f[prioridade]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Waiting list entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Waiting list» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Waiting list entry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/:id", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Waiting list entry", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/:id", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/:id", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Book into a slot", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/:id/acao/marcar", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", ":id", "acao", "marcar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Remove from list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/lista_espera/:id/acao/sair", "host": [ "{{base_url}}" ], "path": [ "r", "lista_espera", ":id", "acao", "sair" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Locations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/locais", "host": [ "{{base_url}}" ], "path": [ "opcoes", "locais" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Locations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais", "host": [ "{{base_url}}" ], "path": [ "r", "locais" ], "query": [ { "key": "f[localidade]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Location", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais", "host": [ "{{base_url}}" ], "path": [ "r", "locais" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Locations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "locais", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Location", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "locais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Location", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "locais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/locais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "locais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Appointment types", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/marcacao_tipos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "marcacao_tipos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Appointment types", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos" ], "query": [ { "key": "f[teleconsulta]", "value": "", "disabled": true }, { "key": "f[cirurgia]", "value": "", "disabled": true }, { "key": "f[online]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Appointment type", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Appointment types» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Appointment type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Appointment type", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacao_tipos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcacao_tipos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Appointments", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/marcacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "marcacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Appointments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes" ], "query": [ { "key": "f[inicio]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo_id]", "value": "", "disabled": true }, { "key": "f[profissional_id]", "value": "", "disabled": true }, { "key": "f[sala_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Appointments» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Appointment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/cancelar", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Arrived", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/chegou", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "chegou" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/concluir", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Confirm", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/confirmar", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "confirmar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: No-show", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/faltou", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "faltou" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Send reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/lembrete", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "lembrete" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reschedule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcacoes/:id/acao/remarcar", "host": [ "{{base_url}}" ], "path": [ "r", "marcacoes", ":id", "acao", "remarcar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Follow-up milestones", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/marcos_acompanhamento", "host": [ "{{base_url}}" ], "path": [ "opcoes", "marcos_acompanhamento" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Follow-up milestones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[marco]", "value": "", "disabled": true }, { "key": "f[data_prevista]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Follow-up milestone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Follow-up milestones» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Follow-up milestone", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Follow-up milestone", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id/acao/concluir", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id", "acao", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Request photographs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id/acao/pedir_fotos", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id", "acao", "pedir_fotos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Recall task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/marcos_acompanhamento/:id/acao/recuperacao", "host": [ "{{base_url}}" ], "path": [ "r", "marcos_acompanhamento", ":id", "acao", "recuperacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: 3D models", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/modelos3d", "host": [ "{{base_url}}" ], "path": [ "opcoes", "modelos3d" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List 3D models", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[formato]", "value": "", "disabled": true }, { "key": "f[escala_confirmada]", "value": "", "disabled": true }, { "key": "f[qualidade]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create 3D model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «3D models» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get 3D model", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update 3D model", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "r", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Engine versions", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/motor_versoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "motor_versoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Engine versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Engine versions» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Engine version", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: aprovar." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: New draft from this version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/motor_versoes/:id/acao/novo_rascunho", "host": [ "{{base_url}}" ], "path": [ "r", "motor_versoes", ":id", "acao", "novo_rascunho" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Sales goals", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/objetivos_comerciais", "host": [ "{{base_url}}" ], "path": [ "opcoes", "objetivos_comerciais" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Sales goals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais" ], "query": [ { "key": "f[periodo]", "value": "", "disabled": true }, { "key": "f[utilizador_id]", "value": "", "disabled": true }, { "key": "f[equipa_id]", "value": "", "disabled": true }, { "key": "f[metrica]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Sales goal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Sales goals» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Sales goal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Sales goal", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/objetivos_comerciais/:id", "host": [ "{{base_url}}" ], "path": [ "r", "objetivos_comerciais", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Patients", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/pacientes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "pacientes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Patients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes" ], "query": [ { "key": "f[sexo]", "value": "", "disabled": true }, { "key": "f[data_nascimento]", "value": "", "disabled": true }, { "key": "f[localidade]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[medico_id]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[portal_ativo]", "value": "", "disabled": true }, { "key": "f[litigio]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Patients» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Patient", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Open episode", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id/acao/abrir_episodio", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id", "acao", "abrir_episodio" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: New consultation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id/acao/nova_consulta", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id", "acao", "nova_consulta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Request form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id/acao/pedir_formulario", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id", "acao", "pedir_formulario" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes/:id/acao/reativar", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes", ":id", "acao", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Clinical alerts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/pacientes_alertas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "pacientes_alertas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Clinical alerts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[gravidade]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true }, { "key": "f[validado]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Clinical alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Clinical alerts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Clinical alert", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Clinical alert", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Deactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/:id/acao/desativar", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", ":id", "acao", "desativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/:id/acao/reativar", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", ":id", "acao", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Validate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pacientes_alertas/:id/acao/validar", "host": [ "{{base_url}}" ], "path": [ "r", "pacientes_alertas", ":id", "acao", "validar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Payments", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/pagamentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "pagamentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[metodo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[vence_em]", "value": "", "disabled": true }, { "key": "f[pago_em]", "value": "", "disabled": true }, { "key": "f[confirmacao]", "value": "", "disabled": true }, { "key": "f[proposta_id]", "value": "", "disabled": true }, { "key": "f[episodio_id]", "value": "", "disabled": true }, { "key": "f[caixa_id]", "value": "", "disabled": true }, { "key": "f[local_id]", "value": "", "disabled": true }, { "key": "f[conta_id]", "value": "", "disabled": true }, { "key": "f[convencao_id]", "value": "", "disabled": true }, { "key": "f[terminal_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Payments» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Payment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Payment", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id/acao/cancelar", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id", "acao", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Check status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id/acao/consultar_estado", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id", "acao", "consultar_estado" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Issue tax document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id/acao/emitir_fatura", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id", "acao", "emitir_fatura" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as paid", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id/acao/marcar_pago", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id", "acao", "marcar_pago" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Refund", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pagamentos/:id/acao/reembolsar", "host": [ "{{base_url}}" ], "path": [ "r", "pagamentos", ":id", "acao", "reembolsar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Partners", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/parceiros", "host": [ "{{base_url}}" ], "path": [ "opcoes", "parceiros" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Partners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Partners» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Partner", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Partner", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id/acao/reativar", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id", "acao", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Decline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id/acao/recusar", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id", "acao", "recusar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Suspend", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id/acao/suspender", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id", "acao", "suspender" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: End sessions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros/:id/acao/terminar_sessoes", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros", ":id", "acao", "terminar_sessoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Partner referrals", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/parceiros_encaminhamentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "parceiros_encaminhamentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Partner referrals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos" ], "query": [ { "key": "f[parceiro_id]", "value": "", "disabled": true }, { "key": "f[estado_manual]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Partner referrals» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Referral", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Referral", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Record patient authorisation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/:id/acao/registar_autorizacao", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", ":id", "acao", "registar_autorizacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Revoke authorisation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/parceiros_encaminhamentos/:id/acao/revogar_autorizacao", "host": [ "{{base_url}}" ], "path": [ "r", "parceiros_encaminhamentos", ":id", "acao", "revogar_autorizacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Data subject requests", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/pedidos_titulares", "host": [ "{{base_url}}" ], "path": [ "opcoes", "pedidos_titulares" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Data subject requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[recebido_em]", "value": "", "disabled": true }, { "key": "f[prazo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[tratado_por]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Data subject request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Data subject requests» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Data subject request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Data subject request", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Apply erasure", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id/acao/aplicar_apagamento", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id", "acao", "aplicar_apagamento" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as under review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id/acao/em_analise", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id", "acao", "em_analise" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Export data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id/acao/exportar_dados", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id", "acao", "exportar_dados" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Extend deadline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id/acao/prorrogar", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id", "acao", "prorrogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Respond", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pedidos_titulares/:id/acao/responder", "host": [ "{{base_url}}" ], "path": [ "r", "pedidos_titulares", ":id", "acao", "responder" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Profiles", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/perfis", "host": [ "{{base_url}}" ], "path": [ "opcoes", "perfis" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/perfis", "host": [ "{{base_url}}" ], "path": [ "r", "perfis" ], "query": [ { "key": "f[departamento]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Profiles» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/perfis/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "perfis", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/perfis/:id", "host": [ "{{base_url}}" ], "path": [ "r", "perfis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Surgical plans", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/planos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "planos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Surgical plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos", "host": [ "{{base_url}}" ], "path": [ "r", "planos" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Schema of «Surgical plans» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "planos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Surgical plan", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "planos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "planos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Approve", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "planos", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: aprovar." } }, { "name": "Action: New version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/:id/acao/nova_versao", "host": [ "{{base_url}}" ], "path": [ "r", "planos", ":id", "acao", "nova_versao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Submit for review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/planos/:id/acao/submeter", "host": [ "{{base_url}}" ], "path": [ "r", "planos", ":id", "acao", "submeter" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Portal accounts", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/portal_contas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "portal_contas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Portal accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Portal account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Portal accounts» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Portal account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Reactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas/:id/acao/reativar", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas", ":id", "acao", "reativar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Suspend", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas/:id/acao/suspender", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas", ":id", "acao", "suspender" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: End sessions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_contas/:id/acao/terminar", "host": [ "{{base_url}}" ], "path": [ "r", "portal_contas", ":id", "acao", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Portal requests", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/portal_pedidos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "portal_pedidos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Portal requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[prazo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Portal requests» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Portal request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Accept and apply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/:id/acao/aceitar", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", ":id", "acao", "aceitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark under review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/:id/acao/analisar", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", ":id", "acao", "analisar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Complete and reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/:id/acao/concluir", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", ":id", "acao", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Decline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/portal_pedidos/:id/acao/recusar", "host": [ "{{base_url}}" ], "path": [ "r", "portal_pedidos", ":id", "acao", "recusar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Online assessments", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/pre_avaliacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "pre_avaliacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Online assessments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[procedimento]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[parecer]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Online assessments» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Online assessment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Open lead", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/:id/acao/abrir_lead", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", ":id", "acao", "abrir_lead" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Send reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/:id/acao/enviar_resposta", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", ":id", "acao", "enviar_resposta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Mark as reviewed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/:id/acao/marcar_revista", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", ":id", "acao", "marcar_revista" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } }, { "name": "Action: Open review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/pre_avaliacoes/:id/acao/rever", "host": [ "{{base_url}}" ], "path": [ "r", "pre_avaliacoes", ":id", "acao", "rever" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } } ] }, { "name": "Recurso: Procedures", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/procedimentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "procedimentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Procedures", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[tecnica]", "value": "", "disabled": true }, { "key": "f[area]", "value": "", "disabled": true }, { "key": "f[iva_validado]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Procedure", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Procedures» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Procedure", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Procedure", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/procedimentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "procedimentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Proposals", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/propostas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "propostas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Proposals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/propostas", "host": [ "{{base_url}}" ], "path": [ "r", "propostas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[lead_id]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[moeda]", "value": "", "disabled": true }, { "key": "f[desconto_estado]", "value": "", "disabled": true }, { "key": "f[validade_ate]", "value": "", "disabled": true }, { "key": "f[enviada_em]", "value": "", "disabled": true }, { "key": "f[aceite_em]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Proposals» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/propostas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "propostas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Proposal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/propostas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/propostas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Photo protocols", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/protocolos_foto", "host": [ "{{base_url}}" ], "path": [ "opcoes", "protocolos_foto" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Photo protocols", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto" ], "query": [ { "key": "f[marco]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Photo protocol", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Photo protocols» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Photo protocol", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Photo protocol", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/protocolos_foto/:id", "host": [ "{{base_url}}" ], "path": [ "r", "protocolos_foto", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Ad audiences", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/publicos_anuncios", "host": [ "{{base_url}}" ], "path": [ "opcoes", "publicos_anuncios" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Ad audiences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios" ], "query": [ { "key": "f[plataforma]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Audience", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Ad audiences» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Audience", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Audience", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios/:id", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Send now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/publicos_anuncios/:id/acao/enviar", "host": [ "{{base_url}}" ], "path": [ "r", "publicos_anuncios", ":id", "acao", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Complaints, compliments and suggestions", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/reclamacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "reclamacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Complaints, compliments and suggestions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[categoria]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[recebida_em]", "value": "", "disabled": true }, { "key": "f[prazo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true }, { "key": "f[exportada_ers_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Complaint", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Complaints, compliments and suggestions» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Complaint", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Complaint", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Close", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id/acao/encerrar", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id", "acao", "encerrar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Respond", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id/acao/responder", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id", "acao", "responder" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Start handling", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reclamacoes/:id/acao/tratar", "host": [ "{{base_url}}" ], "path": [ "r", "reclamacoes", ":id", "acao", "tratar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Rooms, equipment and interpreters", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/recursos_agenda", "host": [ "{{base_url}}" ], "path": [ "opcoes", "recursos_agenda" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Rooms, equipment and interpreters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true }, { "key": "f[bloco]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Schedule resource", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Rooms, equipment and interpreters» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Schedule resource", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda/:id", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Schedule resource", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda/:id", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/recursos_agenda/:id", "host": [ "{{base_url}}" ], "path": [ "r", "recursos_agenda", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Eligibility rules", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/regras_elegibilidade", "host": [ "{{base_url}}" ], "path": [ "opcoes", "regras_elegibilidade" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Eligibility rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade" ], "query": [ { "key": "f[nivel]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Eligibility rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Eligibility rules» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Eligibility rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Eligibility rule", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Activate / deactivate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id/acao/alternar", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id", "acao", "alternar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Approve rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id/acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id", "acao", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: aprovar." } }, { "name": "Action: Archive", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/regras_elegibilidade/:id/acao/arquivar", "host": [ "{{base_url}}" ], "path": [ "r", "regras_elegibilidade", ":id", "acao", "arquivar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Scheduled reports", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/relatorios_agendados", "host": [ "{{base_url}}" ], "path": [ "opcoes", "relatorios_agendados" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Scheduled reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados" ], "query": [ { "key": "f[periodicidade]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Scheduled report", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Scheduled reports» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Scheduled report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Scheduled report", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados/:id", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Send now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/relatorios_agendados/:id/acao/enviar_agora", "host": [ "{{base_url}}" ], "path": [ "r", "relatorios_agendados", ":id", "acao", "enviar_agora" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Quick replies", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/respostas_rapidas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "respostas_rapidas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Quick replies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[idioma]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Quick reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Quick replies» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Quick reply", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Quick reply", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/respostas_rapidas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "respostas_rapidas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Meetings", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/reunioes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "reunioes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Meetings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes" ], "query": [ { "key": "f[inicio]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Meeting", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Meetings» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Meeting", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Meeting", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Cancel", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id/acao/cancelar", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id", "acao", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Start", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id/acao/iniciar", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id", "acao", "iniciar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Suggest a summary of the notes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id/acao/resumir", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id", "acao", "resumir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: End", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/reunioes/:id/acao/terminar", "host": [ "{{base_url}}" ], "path": [ "r", "reunioes", ":id", "acao", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Access reviews", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/revisoes_acessos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "revisoes_acessos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Access reviews", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/revisoes_acessos", "host": [ "{{base_url}}" ], "path": [ "r", "revisoes_acessos" ], "query": [ { "key": "f[periodo]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Access reviews» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/revisoes_acessos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "revisoes_acessos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Access review", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/revisoes_acessos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "revisoes_acessos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/revisoes_acessos/:id/acao/concluir", "host": [ "{{base_url}}" ], "path": [ "r", "revisoes_acessos", ":id", "acao", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: View snapshot", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/revisoes_acessos/:id/acao/ver", "host": [ "{{base_url}}" ], "path": [ "r", "revisoes_acessos", ":id", "acao", "ver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } } ] }, { "name": "Recurso: Segments", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/segmentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "segmentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Segments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos" ], "query": [ { "key": "f[usa_dados_clinicos]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Segment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Segments» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Segment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Segment", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Count now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/segmentos/:id/acao/contar", "host": [ "{{base_url}}" ], "path": [ "r", "segmentos", ":id", "acao", "contar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } } ] }, { "name": "Recurso: Sequences", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/sequencias", "host": [ "{{base_url}}" ], "path": [ "opcoes", "sequencias" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Sequences", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias" ], "query": [ { "key": "f[gatilho]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Sequence", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Sequences» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Sequence", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Sequence", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/sequencias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "sequencias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Stock movements", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/stock_movimentos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "stock_movimentos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Stock movements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/stock_movimentos", "host": [ "{{base_url}}" ], "path": [ "r", "stock_movimentos" ], "query": [ { "key": "f[artigo_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[lote]", "value": "", "disabled": true }, { "key": "f[validade]", "value": "", "disabled": true }, { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[cirurgia_id]", "value": "", "disabled": true }, { "key": "f[encomenda_id]", "value": "", "disabled": true }, { "key": "f[criado_em]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Stock movement", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/stock_movimentos", "host": [ "{{base_url}}" ], "path": [ "r", "stock_movimentos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Stock movements» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/stock_movimentos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "stock_movimentos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Stock movement", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/stock_movimentos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "stock_movimentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Processors", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/subcontratantes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "subcontratantes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Processors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes" ], "query": [ { "key": "f[pais]", "value": "", "disabled": true }, { "key": "f[contrato_ate]", "value": "", "disabled": true }, { "key": "f[dpa_assinado]", "value": "", "disabled": true }, { "key": "f[sistema_ia]", "value": "", "disabled": true }, { "key": "f[transferencia_internacional]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Processor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Processors» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Processor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Processor", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/subcontratantes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "subcontratantes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Contact opt-outs", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/supressoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "supressoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Contact opt-outs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/supressoes", "host": [ "{{base_url}}" ], "path": [ "r", "supressoes" ], "query": [ { "key": "f[canal]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Opt-out", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/supressoes", "host": [ "{{base_url}}" ], "path": [ "r", "supressoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Contact opt-outs» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/supressoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "supressoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Opt-out", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/supressoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "supressoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/supressoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "supressoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Price lists", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/tabelas_precos", "host": [ "{{base_url}}" ], "path": [ "opcoes", "tabelas_precos" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Price lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[procedimento_id]", "value": "", "disabled": true }, { "key": "f[local_id]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Price list", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Price lists» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Price list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Price list", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Simulate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tabelas_precos/:id/acao/simular", "host": [ "{{base_url}}" ], "path": [ "r", "tabelas_precos", ":id", "acao", "simular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } } ] }, { "name": "Recurso: Tasks", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/tarefas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "tarefas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Tasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas" ], "query": [ { "key": "f[prioridade]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[prazo]", "value": "", "disabled": true }, { "key": "f[responsavel_id]", "value": "", "disabled": true }, { "key": "f[departamento]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Tasks» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Task", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Task", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/:id/acao/concluir", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", ":id", "acao", "concluir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reopen", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tarefas/:id/acao/reabrir", "host": [ "{{base_url}}" ], "path": [ "r", "tarefas", ":id", "acao", "reabrir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Teleconsultations", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/teleconsultas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "teleconsultas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Teleconsultations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/teleconsultas", "host": [ "{{base_url}}" ], "path": [ "r", "teleconsultas" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[medico_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Schema of «Teleconsultations» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/teleconsultas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "teleconsultas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Teleconsultation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/teleconsultas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "teleconsultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } } ] }, { "name": "Recurso: Extensions", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/telefonia_extensoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "telefonia_extensoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Extensions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Extension", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Extensions» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Extension", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Extension", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_extensoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_extensoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Clinic numbers", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/telefonia_numeros", "host": [ "{{base_url}}" ], "path": [ "opcoes", "telefonia_numeros" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Clinic numbers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros" ], "query": [ { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Number", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Clinic numbers» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Number", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Number", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/telefonia_numeros/:id", "host": [ "{{base_url}}" ], "path": [ "r", "telefonia_numeros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Payment terminals", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/terminais_pagamento", "host": [ "{{base_url}}" ], "path": [ "opcoes", "terminais_pagamento" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Payment terminals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento" ], "query": [ { "key": "f[fornecedor]", "value": "", "disabled": true }, { "key": "f[local_id]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Payment terminal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Payment terminals» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Payment terminal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Payment terminal", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/:id", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Pair", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/:id/acao/emparelhar", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", ":id", "acao", "emparelhar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Check status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/terminais_pagamento/:id/acao/verificar", "host": [ "{{base_url}}" ], "path": [ "r", "terminais_pagamento", ":id", "acao", "verificar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: ver." } } ] }, { "name": "Recurso: Complementary treatments", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/tratamentos_complementares", "host": [ "{{base_url}}" ], "path": [ "opcoes", "tratamentos_complementares" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Complementary treatments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "f[inicio]", "value": "", "disabled": true }, { "key": "f[adesao]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Complementary treatment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Complementary treatments» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Complementary treatment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Complementary treatment", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Record session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tratamentos_complementares/:id/acao/registar_sessao", "host": [ "{{base_url}}" ], "path": [ "r", "tratamentos_complementares", ":id", "acao", "registar_sessao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Trichoscopy fields", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/tricoscopias", "host": [ "{{base_url}}" ], "path": [ "opcoes", "tricoscopias" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Trichoscopy fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias" ], "query": [ { "key": "f[paciente_id]", "value": "", "disabled": true }, { "key": "f[captura_id]", "value": "", "disabled": true }, { "key": "f[data]", "value": "", "disabled": true }, { "key": "f[subzona]", "value": "", "disabled": true }, { "key": "f[aparelho]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission. Every read is audited." } }, { "name": "Create Trichoscopy field", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Trichoscopy fields» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Trichoscopy field", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Trichoscopy field", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/tricoscopias/:id", "host": [ "{{base_url}}" ], "path": [ "r", "tricoscopias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Users", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/utilizadores", "host": [ "{{base_url}}" ], "path": [ "opcoes", "utilizadores" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores" ], "query": [ { "key": "f[perfil_id]", "value": "", "disabled": true }, { "key": "f[nivel]", "value": "", "disabled": true }, { "key": "f[departamento]", "value": "", "disabled": true }, { "key": "f[direcao_clinica]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true }, { "key": "f[totp_ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Users» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get User", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update User", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Unlock", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id/acao/desbloquear", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id", "acao", "desbloquear" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Send invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id/acao/enviar_convite", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id", "acao", "enviar_convite" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Reset second factor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id/acao/repor_2fa", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id", "acao", "repor_2fa" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: End sessions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/utilizadores/:id/acao/revogar_sessoes", "host": [ "{{base_url}}" ], "path": [ "r", "utilizadores", ":id", "acao", "revogar_sessoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Gift vouchers", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/vales", "host": [ "{{base_url}}" ], "path": [ "opcoes", "vales" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Gift vouchers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/vales", "host": [ "{{base_url}}" ], "path": [ "r", "vales" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[validade]", "value": "", "disabled": true }, { "key": "f[finalidade]", "value": "", "disabled": true }, { "key": "f[comprador_paciente_id]", "value": "", "disabled": true }, { "key": "f[local_id]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Gift vouchers» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/vales/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "vales", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Gift voucher", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/vales/:id", "host": [ "{{base_url}}" ], "path": [ "r", "vales", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Gift voucher", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/vales/:id", "host": [ "{{base_url}}" ], "path": [ "r", "vales", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Action: Cancel voucher", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/vales/:id/acao/anular", "host": [ "{{base_url}}" ], "path": [ "r", "vales", ":id", "acao", "anular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Recorded messages", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/voz_gravacoes", "host": [ "{{base_url}}" ], "path": [ "opcoes", "voz_gravacoes" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Recorded messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes" ], "query": [ { "key": "f[lingua]", "value": "", "disabled": true }, { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Recorded message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Recorded messages» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Recorded message", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Recorded message", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_gravacoes/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_gravacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } } ] }, { "name": "Recurso: Voice menus", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/voz_menus", "host": [ "{{base_url}}" ], "path": [ "opcoes", "voz_menus" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Voice menus", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus" ], "query": [ { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Voice menu", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Voice menus» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Voice menu", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Voice menu", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus/:id", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Open the editor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/voz_menus/:id/acao/editor", "host": [ "{{base_url}}" ], "path": [ "r", "voz_menus", ":id", "acao", "editor" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Webhooks", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/webhooks", "host": [ "{{base_url}}" ], "path": [ "opcoes", "webhooks" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks" ], "query": [ { "key": "f[ativo]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create Webhook destination", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «Webhooks» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Webhook destination", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update Webhook destination", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Rotate secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/:id/acao/rodar_segredo", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", ":id", "acao", "rodar_segredo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } }, { "name": "Action: Send test", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks/:id/acao/testar", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks", ":id", "acao", "testar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: Webhook deliveries", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/webhooks_entregas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "webhooks_entregas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List Webhook deliveries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks_entregas", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks_entregas" ], "query": [ { "key": "f[webhook_id]", "value": "", "disabled": true }, { "key": "f[evento]", "value": "", "disabled": true }, { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Schema of «Webhook deliveries» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks_entregas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks_entregas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get Delivery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks_entregas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks_entregas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Action: Resend", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/webhooks_entregas/:id/acao/reenviar", "host": [ "{{base_url}}" ], "path": [ "r", "webhooks_entregas", ":id", "acao", "reenviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Recurso: WhatsApp lines", "item": [ { "name": "Options for pickers (id, label)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/opcoes/whatsapp_linhas", "host": [ "{{base_url}}" ], "path": [ "opcoes", "whatsapp_linhas" ], "query": [ { "key": "ids", "value": "1,2", "disabled": true } ] }, "description": "" } }, { "name": "List WhatsApp lines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas" ], "query": [ { "key": "f[departamento]", "value": "", "disabled": true }, { "key": "f[ativa]", "value": "", "disabled": true } ] }, "description": "Search, filters, sorting and pagination; honours scope (own/team/all) and strips fields without permission." } }, { "name": "Create WhatsApp line", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas" ] }, "description": "Server-side validation generated from the field definitions. Accepts Idempotency-Key." } }, { "name": "Schema of «WhatsApp lines» (fields, sections, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas/esquema", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas", "esquema" ] }, "description": "Returns only the fields and actions the caller may access, labelled in the requested language." } }, { "name": "Get WhatsApp line", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Record within scope (out of scope answers 404). Encrypted fields are decrypted only for permitted callers." } }, { "name": "Update WhatsApp line", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial update: only the fields sent." } }, { "name": "Delete (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas/:id", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The record is hidden but kept for legal and audit purposes." } }, { "name": "Action: Test the line", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/r/whatsapp_linhas/:id/acao/testar", "host": [ "{{base_url}}" ], "path": [ "r", "whatsapp_linhas", ":id", "acao", "testar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Required level: editar." } } ] }, { "name": "Ficha do paciente", "item": [ { "name": "Possible duplicates of data not yet saved", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/pacientes/duplicados", "host": [ "{{base_url}}" ], "path": [ "pacientes", "duplicados" ] }, "description": "The route has no permission of its own: the controller requires «view» on ficha.identificacao OR on crm.leads (sales check before converting a lead). Team and integrations. Same criteria and output as GET /pacientes/{id}/duplicados; excluir_id removes one patient from the comparison. Stores nothing. Limit (default): 120 requests per minute per team token; integrations use the per-minute limit set on the integration client (429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Rui\",\n \"apelidos\": \"Almeida\",\n \"email\": \"rui.almeida@exemplo.pt\",\n \"telefone\": \"912 345 678\",\n \"data_nascimento\": \"1988-04-12\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Import patient records (CSV)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/importar", "host": [ "{{base_url}}" ], "path": [ "pacientes", "importar" ] }, "description": "Two steps: gravar = 0 previews (each row validated and compared with existing patients), gravar = 1 imports. .csv or .txt text file, up to 5 MB and 5000 rows, «;», «,» or tab separator (detected), UTF-8 or Latin-1 (cp1252, converted); read and discarded, never stored. Accepted headers, accent- and case-insensitive, with synonyms: nome, apelidos, nome completo, email, telefone, telefone alternativo, data de nascimento, sexo, nif, morada, codigo postal, localidade, pais, nacionalidade, idioma, profissao, cliente desde, notas, numero anterior (goes into the notes). A name column is required. Strong duplicates are left out; invalid rows end up as «erro» with the messages. Effects when importing: patients with the clinic number and «importacao» source, timeline and paciente.criado webhook per patient, audit. History (compatible addition, «tipo» field): pacientes (default), consultas, alertas or episodios. Each history row identifies the patient by one column: numero paciente (current record), numero anterior (the old system number recorded when importing patients), nif, email or full name + date of birth (only with a single strong candidate). Consultations (date column required; type, reason, history, medication, allergies, habits, family history, expectations, examination, diagnosis, differential diagnosis, notes, scale, grade, technique, area): require ficha.clinica edit and the patient in clinical scope; they come in CLOSED («assinada» status, «importacao» source, fingerprint, addendum with the provenance); duplicate = same patient, day and type. Alerts (description required; type, severity): ficha.clinica edit; they come in AWAITING VALIDATION; duplicate = same type and description. Episodes (title required; technique, area, status, start, end): identification or clinical record edit; no tasks nor webhooks; duplicate = same title and start day. With gravar = 1 a row is kept in the «importacoes» resource (per-row report without names nor clinical content) and the response carries importacao_id. History rows carry «paciente» {id, numero} instead of the name. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 20 requests per 10 minutes per IP address (only data-changing requests count)." } }, { "name": "Import types and accepted columns", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/importar/modelos", "host": [ "{{base_url}}" ], "path": [ "pacientes", "importar", "modelos" ] }, "description": "For each type (pacientes, consultas, alertas, episodios): whether the person can import it, the required and accepted columns and a sample line. Requires identification or clinical record edit (otherwise 403). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Possible duplicates of this patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/duplicados", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "duplicados" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Compares the patient with the others in the clinic (excluding anonymised ones): same tax number 100, same email 85 (95 with the same date of birth), very similar name + same date 80, same phone 60 (80 with similar name), same date + same last surname 45. Only candidates scoring 40 or more, sorted, at most 12; «strong» from 80. Minimal identification only, with masked email and phone — never clinical data. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Open the patient record", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/ficha", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "ficha" ], "query": [ { "key": "episodio_id", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires ficha.identificacao ≥ summary and the patient in scope (identification or clinical), or an active emergency access. Returns the header, the episodes (no clinical content), the active episode, the journey (stage 1–9 and the section to open at each stage), the visible sections with counters and the available actions. Contacts and date of birth only with ficha.identificacao ≥ view; clinical alerts only for callers who see the patient clinical record (otherwise alertas = [] and alertas_visiveis = false); the face photo only with ficha.fotografias. Opening is audited («ver», ficha). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Blocks of a record section", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/ficha/:seccao", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "ficha", ":seccao" ], "query": [ { "key": "episodio_id", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" }, { "key": "seccao", "value": "clinica" } ] }, "description": "Sections discovered across every module: identificacao, clinica, alertas, episodios, linha_tempo (M1), consentimentos, documentos, privacidade (M2), fotografias, plano, acompanhamento (M3), comunicacoes (M4), financeiro (M5), marcacoes, cirurgias (M6). Each section requires its module permission and level (invisible section → 403); unknown or malformed key → 404. Blocks follow the single format (kpis, lista, campos, grafico, galeria, cronologia, alerta, jornada, acoes) and never carry fields without permission; at «summary» level only the authorised summary. Reading clinical sections (clinica, alertas, fotografias, plano, acompanhamento, cirurgias) is audited («ver», ficha.
). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Assisted merge (keeps {id})", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/pacientes/:id/fundir", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "fundir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires confirmar = true. Copies into {id} the fields listed in «campos» (merge list only) and fills empty ones with those of remover_id; reassigns paciente_id in every system table (current clinic rows only), within a transaction; archives and soft-deletes remover_id. Immutable tables refusing the change are listed in «ignoradas». 422 if it is the same patient, does not exist or either is anonymised. Effects: timeline, «alterar» audit (kept) and «apagar» audit (removed), paciente.fundido webhook. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"remover_id\": 1388,\n \"confirmar\": true,\n \"campos\": [\n \"telefone\",\n \"morada\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Side-by-side comparison for merging", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/fundir/:outro_id", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "fundir", ":outro_id" ], "variable": [ { "key": "id", "value": "1" }, { "key": "outro_id", "value": "1" } ] }, "description": "Identification only (full name and the fields the merge may copy); tax number and document masked. {id} is the patient that stays, {outro_id} the one to be merged in. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Medication alerts before prescribing", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/medicacao", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "medicacao" ], "query": [ { "key": "farmaco", "value": "", "disabled": false } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Checks a drug against the patient own record: 1) recorded allergies (active allergy alerts and allergies from the last consultation) mentioning the drug → «bloqueio»; 2) contraindication rules configured by the clinic (drug | terms to look for in the record | message | alert or block). seguro = false when there is any block. Prescribing itself happens in the certified software configured by the clinic. Requires clinical access to the patient. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Latest record summary (doctors)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/resumo", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "resumo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Latest summary generated for the patient (pending or accepted «resumo» proposal), to show without generating another; null when there is none. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Generate the record summary before the consultation (doctors)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/resumo", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "resumo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Gathers on the server the essentials of the record (age, sex, active alerts, last 3 consultations, episodes, complications and the latest pre-consultation questionnaire) and asks the clinic's AI assistant for a summary of up to 12 lines. No body. Uses the clinic's AI assistant: requires a valid «ia» consent from the patient and the use to be configured (otherwise 422). The result is never a decision — each value becomes a pending proposal (ia_propostas) recording the model used, the request parameters and the explanatory factors, until a doctor accepts, corrects or refuses it. Doctors only («medico» profile family) with «edit» on ficha.clinica and the patient in clinical scope; other profiles receive 403. Returns the created proposal (type «resumo», field «resumo»). Effects: pending proposal, «create» audit on ia_propostas. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After). Additional limit: 20 requests per 10 minutes per IP address (only data-changing requests count)." } }, { "name": "Patient summary in HL7 FHIR R4 (International Patient Summary)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/pacientes/:id/resumo-fhir", "host": [ "{{base_url}}" ], "path": [ "pacientes", ":id", "resumo-fhir" ], "query": [ { "key": "envelope", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Preparation for the European Health Data Space. FHIR R4 «document» Bundle with the IPS profile: Composition (LOINC 60591-5), Patient (record number, name, sex, date of birth — no tax number, ID document, contacts nor address), Organization (the clinic), allergy (48765-2), medication (10160-0) and problem (11450-4) sections from the active clinical alerts (validated → confirmed, awaiting validation → unconfirmed) and the diagnoses of signed consultations, and procedures (47519-4) from episodes at surgery or later; without data, the IPS «absent/unknown» entries. Sections the patient restricted in the portal are left out (emptyReason «withheld»), except with emergency access, which is recorded. By default returns the FHIR JSON as is (application/fhir+json); with envelope=1 it comes in the common envelope with meta.ficheiro. Team and integrations; the patient must be in clinical scope. Effects: «exportar» audit. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per team token; integrations use the per-minute limit set on the integration client (429 with Retry-After). Additional limit: 30 requests per 10 minutes per IP address (only data-changing requests count)." } }, { "name": "Portal: per-section access restrictions on my record", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/ficha/restricoes", "host": [ "{{base_url}}" ], "path": [ "portal", "ficha", "restricoes" ] }, "description": "Patient tokens only (portal). The sections the patient can restrict (consultations, photos, plan, surgeries, follow-up, documents, consents, communications, bookings and financial, those installed) and the status of each. Clinical alerts, identification, episodes and the timeline are never restricted. Follows the portal «acessos» feature." } }, { "name": "Portal: restrict a section or lift the restriction", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/ficha/restricoes", "host": [ "{{base_url}}" ], "path": [ "portal", "ficha", "restricoes" ] }, "description": "With the restriction active, the section stays listed in the record (marked «restrita», without a counter) but only opens with emergency access, which is audited with «quebrar_vidro» and appears in «Who accessed my data»; the FHIR summary leaves it out. Section outside the list → 422 on «seccao». Effects: immutable history row, «alterar» audit and timeline entry (administrative). Returns the same shape as the GET.", "body": { "mode": "raw", "raw": "{\n \"seccao\": \"fotografias\",\n \"restringir\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Portal: my summary in HL7 FHIR R4 (IPS)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/ficha/resumo-fhir", "host": [ "{{base_url}}" ], "path": [ "portal", "ficha", "resumo-fhir" ], "query": [ { "key": "envelope", "value": "", "disabled": true } ] }, "description": "The same Bundle as GET /pacientes/{id}/resumo-fhir, of the own record (restrictions do not apply to oneself). envelope=1 → common envelope with meta.ficheiro. Effects: «exportar» audit." } } ] }, { "name": "Painel", "item": [ { "name": "Dashboard of the current person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/painel", "host": [ "{{base_url}}" ], "path": [ "painel" ], "query": [ { "key": "periodo", "value": "mes", "disabled": true }, { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Discovers the cards of every module visible to the caller (permissions and clinic modules), orders them by role and saved preferences and returns each card's content as blocks (kpis, lista, campos, grafico, galeria, cronologia, alerta, jornada, acoes).\n\nHidden cards come with oculto=true and no blocks. A failing card returns an «alerta» block and erro=falhou — the others still load." } }, { "name": "One dashboard card", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/painel/blocos/:chave", "host": [ "{{base_url}}" ], "path": [ "painel", "blocos", ":chave" ], "query": [ { "key": "periodo", "value": "mes", "disabled": true } ], "variable": [ { "key": "chave", "value": "tarefas_de_hoje" } ] }, "description": "Fresh content of a single card (live refresh). 404 if the card does not exist or is not visible." } }, { "name": "Save the dashboard layout", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/painel/preferencias", "host": [ "{{base_url}}" ], "path": [ "painel", "preferencias" ] }, "description": "Order, hidden cards, widths (1–3) and default period. Only existing card keys are accepted. Stored per person (does not affect colleagues) and audited.", "body": { "mode": "raw", "raw": "{\n \"ordem\": [\n \"resumo_executivo\",\n \"tarefas_de_hoje\",\n \"chat_por_ler\"\n ],\n \"ocultos\": [\n \"comunicados_por_ler\"\n ],\n \"larguras\": {\n \"resumo_executivo\": 3\n },\n \"periodo\": \"semana\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restore the default layout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/painel/repor", "host": [ "{{base_url}}" ], "path": [ "painel", "repor" ] }, "description": "" } } ] }, { "name": "Parceiros", "item": [ { "name": "Sign in (get the token)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/parceiros/auth/entrar", "host": [ "{{base_url}}" ], "path": [ "parceiros", "auth", "entrar" ] }, "description": "Same message for unknown email or wrong password. 403 conta_inativa when the account is unconfirmed, awaiting approval, suspended or declined. 404 when the partner portal is turned off.", "body": { "mode": "raw", "raw": "{\n \"email\": \"dra.silva@clinica-parceira.pt\",\n \"palavra_passe\": \"••••••••••••\",\n \"dispositivo\": \"iPhone\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Request a new password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/parceiros/auth/recuperar", "host": [ "{{base_url}}" ], "path": [ "parceiros", "auth", "recuperar" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"email\": \"dra.silva@clinica-parceira.pt\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Request access", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/parceiros/auth/registar", "host": [ "{{base_url}}" ], "path": [ "parceiros", "auth", "registar" ] }, "description": "Creates the account «to confirm» and sends the verification link (48 h). Same answer whether or not the email exists. Trap field «website» must be empty.", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"medico\",\n \"nome\": \"Marta Silva\",\n \"organizacao\": \"Clínica Dermatológica Exemplo\",\n \"email\": \"dra.silva@clinica-parceira.pt\",\n \"palavra_passe\": \"••••••••••••\",\n \"termos\": true\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Sign out (revokes the token)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/parceiros/auth/sair", "host": [ "{{base_url}}" ], "path": [ "parceiros", "auth", "sair" ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "My account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/parceiros/conta", "host": [ "{{base_url}}" ], "path": [ "parceiros", "conta" ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Change the password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/parceiros/conta/palavra-passe", "host": [ "{{base_url}}" ], "path": [ "parceiros", "conta", "palavra-passe" ] }, "description": "Ends every session and token (sessao_terminada=true): sign in again.", "body": { "mode": "raw", "raw": "{\n \"atual\": \"••••••••••••\",\n \"nova\": \"••••••••••••••\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Refer a patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/parceiros/encaminhamentos", "host": [ "{{base_url}}" ], "path": [ "parceiros", "encaminhamentos" ] }, "description": "The partner declares the patient agreed to be contacted. Creates the lead in the clinic CRM (origin «recommendation») and notifies the team. At least email or phone. Avoid health data in the note.", "body": { "mode": "raw", "raw": "{\n \"nome\": \"João Pereira\",\n \"telefone\": \"+351912345678\",\n \"declaracao\": true\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "One referral (status and, with authorisation, progress)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/parceiros/encaminhamentos/:id", "host": [ "{{base_url}}" ], "path": [ "parceiros", "encaminhamentos", ":id" ], "variable": [ { "key": "id", "value": "14" } ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "My referrals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/parceiros/painel", "host": [ "{{base_url}}" ], "path": [ "parceiros", "painel" ], "query": [ { "key": "estado", "value": "", "disabled": true } ] }, "description": "", "auth": { "type": "noauth" } } } ] }, { "name": "Perfil", "item": [ { "name": "My profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil", "host": [ "{{base_url}}" ], "path": [ "perfil" ] }, "description": "" } }, { "name": "Change personal data and preferences (only the fields sent)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil", "host": [ "{{base_url}}" ], "path": [ "perfil" ] }, "description": "" } }, { "name": "Second factor status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/2fa", "host": [ "{{base_url}}" ], "path": [ "perfil", "2fa" ] }, "description": "" } }, { "name": "Confirm and enable the second factor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/2fa/ativar", "host": [ "{{base_url}}" ], "path": [ "perfil", "2fa", "ativar" ] }, "description": "«atual» (password) is only required when the second factor was already active (reconfiguration). Returns the recovery codes." } }, { "name": "Generate new recovery codes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/2fa/codigos", "host": [ "{{base_url}}" ], "path": [ "perfil", "2fa", "codigos" ] }, "description": "Confirm with the password («atual») or a code («codigo»). Previous ones stop working. Also at POST /perfil/codigos." } }, { "name": "Disable the second factor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/2fa/desativar", "host": [ "{{base_url}}" ], "path": [ "perfil", "2fa", "desativar" ] }, "description": "Refused when the clinic makes it mandatory. Requires a valid code." } }, { "name": "Start second-factor setup", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/2fa/iniciar", "host": [ "{{base_url}}" ], "path": [ "perfil", "2fa", "iniciar" ] }, "description": "Returns the secret and the otpauth:// address (QR code). Pending confirmation for 10 minutes." } }, { "name": "Generate new recovery codes (alias)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/codigos", "host": [ "{{base_url}}" ], "path": [ "perfil", "codigos" ] }, "description": "" } }, { "name": "Change password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/palavra-passe", "host": [ "{{base_url}}" ], "path": [ "perfil", "palavra-passe" ] }, "description": "Ends the other sessions of the account." } }, { "name": "Open app sessions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/sessoes", "host": [ "{{base_url}}" ], "path": [ "perfil", "sessoes" ] }, "description": "" } }, { "name": "End all other sessions", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/sessoes", "host": [ "{{base_url}}" ], "path": [ "perfil", "sessoes" ] }, "description": "Also at POST /perfil/sessoes/revogar." } }, { "name": "End all other sessions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/sessoes/revogar", "host": [ "{{base_url}}" ], "path": [ "perfil", "sessoes", "revogar" ] }, "description": "" } }, { "name": "End one session", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/perfil/sessoes/:id", "host": [ "{{base_url}}" ], "path": [ "perfil", "sessoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Permissões", "item": [ { "name": "Permission matrix", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes", "host": [ "{{base_url}}" ], "path": [ "permissoes" ] }, "description": "profiles, modules (with group, clinical, always active), cells/matrix (profile_id → module → {nivel, ambito, aprovar, exportar}), ceilings (data-protection limits per profile family), scopes, phases (phase rules per profile), positions (additions per position), resources (with configurable fields) and editavel. Requires Users › View." } }, { "name": "Save matrix cells", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes", "host": [ "{{base_url}}" ], "path": [ "permissoes" ] }, "description": "Values above the data-protection ceiling are refused. Nobody can remove access management from themselves." } }, { "name": "Resources with fields configurable per profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/campos", "host": [ "{{base_url}}" ], "path": [ "permissoes", "campos" ], "query": [ { "key": "perfil_id", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Fields of a resource with the profile rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/campos/:perfil_id/:recurso", "host": [ "{{base_url}}" ], "path": [ "permissoes", "campos", ":perfil_id", ":recurso" ], "variable": [ { "key": "perfil_id", "value": "1" }, { "key": "recurso", "value": "1" } ] }, "description": "regra: '' (as defined), oculto (never leaves the server) or so_leitura (writes are refused). Required fields and users/profiles fields of your own profile do not accept rules (bloqueado + motivo)." } }, { "name": "Save hidden or read-only fields", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/permissoes/campos/:perfil_id/:recurso", "host": [ "{{base_url}}" ], "path": [ "permissoes", "campos", ":perfil_id", ":recurso" ], "variable": [ { "key": "perfil_id", "value": "1" }, { "key": "recurso", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"campos\": {\n \"valor_estimado\": \"oculto\",\n \"origem\": \"so_leitura\",\n \"notas\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Permissions per position", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/cargos", "host": [ "{{base_url}}" ], "path": [ "permissoes", "cargos" ] }, "description": "Additions for chefe_equipa and direcao, per department ('' = all): celulas[cargo][departamento][modulo] = {nivel, ambito, aprovar, exportar}; ambito_por_cargo (team lead → team, management → department in non-clinical modules) and whether it is on. Data-protection ceilings always apply." } }, { "name": "Save position additions (level «nenhum» removes)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/cargos", "host": [ "{{base_url}}" ], "path": [ "permissoes", "cargos" ] }, "description": "" } }, { "name": "Revoke an exception before its end", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/excecoes/:id/revogar", "host": [ "{{base_url}}" ], "path": [ "permissoes", "excecoes", ":id", "revogar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Phase rules per profile", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/fases", "host": [ "{{base_url}}" ], "path": [ "permissoes", "fases" ] }, "description": "Phase dimension of the matrix: rules declared per module (type estado|preenchido|dia|passado|jornada) and, per profile, {ativa, nivel (maximum within the phase: nenhum|resumo|ver), origem perfil|omissao}. E.g. sales edit a proposal only until it is accepted; nursing records only on the surgery day. Requires Users › View." } }, { "name": "Turn phase rules on/off per profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/fases", "host": [ "{{base_url}}" ], "path": [ "permissoes", "fases" ] }, "description": "" } }, { "name": "Create a profile from another", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/perfis", "host": [ "{{base_url}}" ], "path": [ "permissoes", "perfis" ] }, "description": "" } }, { "name": "Rename profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/perfis/:id", "host": [ "{{base_url}}" ], "path": [ "permissoes", "perfis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Delete profile (no people and not a base profile)", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/perfis/:id", "host": [ "{{base_url}}" ], "path": [ "permissoes", "perfis", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "People and their profiles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/pessoas", "host": [ "{{base_url}}" ], "path": [ "permissoes", "pessoas" ] }, "description": "" } }, { "name": "Effective permissions of one person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/pessoas/:id", "host": [ "{{base_url}}" ], "path": [ "permissoes", "pessoas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "permissoes (module → {nivel, ambito, aprovar, exportar, origem perfil|cargo|delegacao|excecao|retirada|global|inativo, cargo_ambito}), position, department, teams, delegations, exceptions and editavel. Also at GET /permissoes/utilizadores/{id}." } }, { "name": "Permission exceptions of one person", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/pessoas/:id/excecoes", "host": [ "{{base_url}}" ], "path": [ "permissoes", "pessoas", ":id", "excecoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Grant or remove a module/level for one person", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/permissoes/pessoas/:id/excecoes", "host": [ "{{base_url}}" ], "path": [ "permissoes", "pessoas", ":id", "excecoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "conceder: grants the level (never above the profile family ceiling); retirar: the level becomes at most the one given (nenhum = no module) and aprovar/exportar = 1 remove those flags. Optional end; reason required. Nobody creates exceptions for themselves; removing ends the person's sessions. Audited.", "body": { "mode": "raw", "raw": "{\n \"modulo\": \"indicadores.financeiros\",\n \"tipo\": \"conceder\",\n \"nivel\": \"ver\",\n \"fim\": \"2026-11-30T23:59:00+00:00\",\n \"motivo\": \"Substituição da diretora financeira durante as férias\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Effective permissions of one person (alias)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/utilizadores/:id", "host": [ "{{base_url}}" ], "path": [ "permissoes", "utilizadores", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Save the rows of one profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/:perfil_id", "host": [ "{{base_url}}" ], "path": [ "permissoes", ":perfil_id" ], "variable": [ { "key": "perfil_id", "value": "1" } ] }, "description": "Accepts {linhas:[…]} or {modulos:{:{nivel, ambito, aprovar, exportar}}} (app format)." } }, { "name": "Clone a profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/permissoes/:perfil_id/clonar", "host": [ "{{base_url}}" ], "path": [ "permissoes", ":perfil_id", "clonar" ], "variable": [ { "key": "perfil_id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Planos cirúrgicos", "item": [ { "name": "List plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos", "host": [ "{{base_url}}" ], "path": [ "planos" ], "query": [ { "key": "paciente_id", "value": "", "disabled": true }, { "key": "episodio_id", "value": "", "disabled": true }, { "key": "estado", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true }, { "key": "por_pagina", "value": "", "disabled": true } ] }, "description": "Plans within the user's scope. Users with only the «summary» level receive the authorised summary (no clinical data). Without a status filter, substituted versions are left out." } }, { "name": "Create plan", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos", "host": [ "{{base_url}}" ], "path": [ "planos" ] }, "description": "Creates a draft plan with the diagram zones (densities suggested by the engine version) and the donor (trichoscopy averages, or the reference safe area). Scale, grade and PRECISE come from the last consultation when available. Effects: timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"episodio_id\": 77,\n \"tecnica\": \"FUE\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Donor reserve ledger", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/conta-dadora/:paciente_id", "host": [ "{{base_url}}" ], "path": [ "planos", "conta-dadora", ":paciente_id" ], "variable": [ { "key": "paciente_id", "value": "1" } ] }, "description": "Lifetime capacity (latest approved plan) − grafts extracted in each closed surgery − reserve for future loss = available; lifetime ceiling." } }, { "name": "Get the plan (editor or summary)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id", "host": [ "{{base_url}}" ], "path": [ "planos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With «view»/«edit»: plan, zones, donors, density references per zone, last result, engine version, versions, donor ledger, simulation, captures and 3D models, trichoscopy averages and permissions. With «summary»: {modo:\"resumo\", resumo}. Read is audited." } }, { "name": "Save the draft (and recalculate)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id", "host": [ "{{base_url}}" ], "path": [ "planos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Draft only. Saves plan data, zones and donors and the recalculated result. Areas from «modelo3d» come from the server-side model; «diagrama» uses the standard head areas. Wrong unit → 422.", "body": { "mode": "raw", "raw": "{\n \"plano\": {\n \"cenario\": \"provavel\",\n \"margem_pct\": 0,\n \"escala\": \"norwood\",\n \"grau\": \"V\"\n },\n \"zonas\": [\n {\n \"zona\": \"linha_frontal\",\n \"area_cm2\": {\n \"valor\": 15,\n \"unidade\": \"cm²\"\n },\n \"densidade_alvo\": {\n \"valor\": 25,\n \"unidade\": \"UF/cm²\"\n },\n \"origem_area\": \"manual\",\n \"incluida\": true,\n \"fase\": 1\n },\n {\n \"zona\": \"coroa\",\n \"area_cm2\": 70,\n \"densidade_alvo\": 20,\n \"origem_area\": \"modelo3d\"\n }\n ],\n \"dadoras\": [\n {\n \"subzona\": \"occipital\",\n \"area_cm2\": 190,\n \"densidade_uf_cm2\": 75,\n \"cabelos_por_uf\": 2.1,\n \"calibre_mm\": 0.065,\n \"extraidos_anteriores\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve the plan (doctor)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/aprovar", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "aprovar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires «approve» on ficha.plano and an approved engine version. Recalculates with that version, refuses if blocked, stores the SHA-256 fingerprint of the canonical JSON (input + parameters + version + result) and turns the previous approved one into «substituido». If a surgical consent was already signed, returns the «renovar_consentimento» warning and creates a nursing task. Effects: timeline, «approve» audit, plano.aprovado webhook, episode journey → proposal." } }, { "name": "Calculate on the server (single source of numbers)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/calcular", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "calcular" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Runs the calculation engine with the posted (unsaved) values over the saved plan: need, minimum residual, lifetime and per-session capacity, session-by-session plan, balance, PRECISE and Norwood checks, proposals for negative balance, warnings and blocks, and the three scenarios. Every number carries unit, interval, formula, step-by-step, parameters and source. With gravar:true it saves (requires edit). Value P is only returned to users who see clinic-wide values.", "body": { "mode": "raw", "raw": "{\n \"plano\": {\n \"cenario\": \"provavel\",\n \"margem_pct\": 0,\n \"escala\": \"norwood\",\n \"grau\": \"V\"\n },\n \"zonas\": [\n {\n \"zona\": \"linha_frontal\",\n \"area_cm2\": {\n \"valor\": 15,\n \"unidade\": \"cm²\"\n },\n \"densidade_alvo\": {\n \"valor\": 25,\n \"unidade\": \"UF/cm²\"\n },\n \"origem_area\": \"manual\",\n \"incluida\": true,\n \"fase\": 1\n },\n {\n \"zona\": \"coroa\",\n \"area_cm2\": 70,\n \"densidade_alvo\": 20,\n \"origem_area\": \"modelo3d\"\n }\n ],\n \"dadoras\": [\n {\n \"subzona\": \"occipital\",\n \"area_cm2\": 190,\n \"densidade_uf_cm2\": 75,\n \"cabelos_por_uf\": 2.1,\n \"calibre_mm\": 0.065,\n \"extraidos_anteriores\": 0\n }\n ],\n \"gravar\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Compare graft numbers", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/comparar", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "comparar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "For N grafts: coverage of the need, density per zone, sessions and what remains in the donor; unavailable (with reason) above capacity.", "body": { "mode": "raw", "raw": "{\n \"enxertos\": 2500\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Differences between versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/diferencas", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "diferencas" ], "query": [ { "key": "com", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Create the proposal from the approved plan", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/proposta", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "proposta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Approved plans only; uses the commercial service. 422 when the commercial module is not installed." } }, { "name": "Upload the simulated image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Image validated by content, stored encrypted and flagged «simulation» (never usable in marketing). Resets «shown» and «acknowledgement»." } }, { "name": "AI-generated simulation: state, base photos and images", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao-ia", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao-ia" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Team only. Whether generation is configured, whether the patient gave the «ia» consent, whether the face may be sent visible (consent + clinic option), the three scenarios, the front/top base photos and the generated images (newest first) with their validation state." } }, { "name": "Generate one scenario's simulation from a photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao-ia/gerar", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao-ia", "gerar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "One image per request (may take minutes). Requires the «ia» consent; the face is blurred before sending (unless consent + clinic option); image AI of the «simulacao» use (local service first, external fallback only with the patient-data switch); the image must start from the photo (similarity ≥ 50 %). Stored as an encrypted clinical file and a «simulation» photo with the visible mark burned in; state «por_validar». 422 with the reason when it cannot generate.", "body": { "mode": "raw", "raw": "{\n \"cenario\": \"provavel\",\n \"foto_id\": 5521\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record the simulation video export", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao-ia/video", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao-ia", "video" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The video (before/after or 3D model rotation) is recorded on the device and never goes through the server; this request only records it in the audit trail.", "body": { "mode": "raw", "raw": "{\n \"origem\": \"antes_depois\",\n \"formato\": \"webm\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Acknowledge the simulation notice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao/conhecimento", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao", "conhecimento" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Team: in-person record (edit ficha.plano). Patient (portal/app): own approved plan only; channel «portal» or «app». «sign» audit with the notice text and the image SHA-256.", "body": { "mode": "raw", "raw": "{\n \"canal\": \"app\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record that the simulation was shown", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/simulacao/mostrada", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "simulacao", "mostrada" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Approved plan. Checks the image SHA-256 (exact archived version) and records who showed it and when." } }, { "name": "Submit for medical review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/submeter", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "submeter" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Recalculates and saves; refuses (422) if blocked. The draft becomes «under review» (frozen) and the patient's doctor is notified." } }, { "name": "New version (editable copy)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/planos/:id/versao", "host": [ "{{base_url}}" ], "path": [ "planos", ":id", "versao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Use a validated simulation as the plan simulation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/simulacoes-ia/:id/usar", "host": [ "{{base_url}}" ], "path": [ "simulacoes-ia", ":id", "usar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Validated images only; checks the SHA-256. Resets «shown» and «acknowledgement» (new presentation)." } }, { "name": "Validate or reject a generated simulation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/simulacoes-ia/:id/validar", "host": [ "{{base_url}}" ], "path": [ "simulacoes-ia", ":id", "validar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only plan approvers (doctor). Rejecting requires the note (stored encrypted). With «usar_no_plano», the validated image immediately becomes the plan simulation.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"validar\",\n \"usar_no_plano\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Plataforma — Apresentação", "item": [ { "name": "AnagenSys presentation blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/blocos", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "blocos" ], "query": [ { "key": "idioma", "value": "", "disabled": true } ] }, "description": "Reserved for product management (403 for clinic accounts). Data always lives in the main clinic. meta.paginas has the publication status in pt and en." } }, { "name": "Save a presentation block", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/blocos", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "blocos" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"chave\": \"hero_nota\",\n \"idioma\": \"pt\",\n \"valor\": \"Demonstração de 45 minutos com a equipa do produto.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restore a presentation block", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/blocos/repor", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "blocos", "repor" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"chave\": \"hero_nota\",\n \"idioma\": \"pt\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Presentation settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/definicoes", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "definicoes" ] }, "description": "" } }, { "name": "Save presentation settings", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/definicoes", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "definicoes" ] }, "description": "email_notificacao receives every demo request; dominio is the main address (https:// without path) to which visits on other domains are redirected. Change is audited.", "body": { "mode": "raw", "raw": "{\n \"email_notificacao\": \"produto@anagen.pt\",\n \"dominio\": \"https://anagen.pt\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Presentation image library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/imagens", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "imagens" ], "query": [ { "key": "q", "value": "", "disabled": true } ] }, "description": "Main clinic images used in the presentation (for example, the social sharing image)." } }, { "name": "Upload a presentation image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/imagens", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "imagens" ] }, "description": "Multipart, with the same checks as the CMS (bytes, dimensions, rewrite without metadata, random name). Limit: 60 per 10 minutes." } }, { "name": "Delete an unused image", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/imagens/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "imagens", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Demo request board", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/pedidos", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "pedidos" ], "query": [ { "key": "q", "value": "", "disabled": true } ] }, "description": "Columns by status (new, contacted, demo scheduled, proposal, customer, not pursued, archived), in board order." } }, { "name": "One demo request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Read is audited." } }, { "name": "Update a request", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/pedidos/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "pedidos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Partial fields: estado, responsavel_id, demonstracao_em, notas and contact details. Scheduling the demo on a «novo» or «contactado» request moves it to «demonstracao_marcada». Change is audited.", "body": { "mode": "raw", "raw": "{\n \"responsavel_id\": 3,\n \"demonstracao_em\": \"2026-11-05T15:00:00+00:00\",\n \"notas\": \"Ligar depois das 17h.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Move a request on the board", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/pedidos/:id/mover", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "pedidos", ":id", "mover" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Changes status and position (order from 0); the target column is renumbered.", "body": { "mode": "raw", "raw": "{\n \"estado\": \"proposta\",\n \"ordem\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Publish or unpublish the presentation in one language", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/apresentacao/publicar", "host": [ "{{base_url}}" ], "path": [ "plataforma", "apresentacao", "publicar" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"idioma\": \"en\",\n \"publicar\": true,\n \"motivo\": \"Nova secção de integrações\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Operação da plataforma", "item": [ { "name": "Platform status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao" ] }, "description": "Points of attention ordered by severity, environment, backups, restores, vulnerabilities, dependencies, hosting, security.txt and versions. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Penetration tests, exercises and reviews", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/atividades", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "atividades" ], "query": [ { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true } ] }, "description": " Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Record an activity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/atividades", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "atividades" ] }, "description": "n_ = number of findings per severity (tests and reviews); measured rpo_minutos/rto_minutos (exercises). Without proxima_em: penetration +12 months (settings), exercise +6, dependency review +1, ASVS +12, access +3. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators).", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"exercicio_continuidade\",\n \"titulo\": \"Restauro completo num servidor novo\",\n \"realizada_em\": \"2026-10-29\",\n \"resultado\": \"concluido\",\n \"rpo_minutos\": 1440,\n \"rto_minutos\": 210\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Backups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/copias", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "copias" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[tipo]", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true }, { "key": "por_pagina", "value": "", "disabled": true } ] }, "description": " Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Request a backup now", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/copias/pedir", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "copias", "pedir" ] }, "description": "Creates a «pedida» (manual) request the scheduler runs within minutes. If a request or backup is already pending, returns it. 6 requests per 10 minutes. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators).", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Antes da atualização da versão\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "One backup, with its restore tests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/copias/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "copias", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": " Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Request upload to the external destination", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/copias/:id/enviar", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "copias", ":id", "enviar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Marks the backup «por_enviar»; the scheduler uploads it (with object lock when enabled). Never overwrites or deletes at the destination. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Request an integrity check", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/copias/:id/verificar", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "copias", ":id", "verificar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "SHA-256 fingerprint of the file, HMAC signature of the manifest, full decryption with the content digest and, with a destination, presence and size at the destination. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Test the external destination connection", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/destino/testar", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "destino", "testar" ] }, "description": "Without writing anything: credentials, remote folder, SFTP server fingerprint, bucket object lock. 422 sem_destino when there is no destination. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Request a restore test", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/restauros/pedir", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "restauros", "pedir" ] }, "description": "Restores the given backup (or the latest valid one) into a separate schema configured on the server, compares tables and rows with the manifest, checks a sample of files and drops the schema at the end. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "One restore test", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/restauros/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "restauros", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": " Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Vulnerabilities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/vulnerabilidades", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "vulnerabilidades" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true }, { "key": "f[gravidade]", "value": "", "disabled": true }, { "key": "f[origem]", "value": "", "disabled": true }, { "key": "f[fora_prazo]", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true }, { "key": "por_pagina", "value": "", "disabled": true } ] }, "description": "By severity and deadline. f[estado]: abertas (default), todas or a state. meta.opcoes has the labelled lists. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Record a vulnerability", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/vulnerabilidades", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "vulnerabilidades" ] }, "description": "Without prazo_em, the deadline is the detection date plus the days for the severity (platform settings). Description and notes are stored encrypted. Audited. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators).", "body": { "mode": "raw", "raw": "{\n \"titulo\": \"Cabeçalho de segurança em falta numa página pública\",\n \"gravidade\": \"media\",\n \"origem\": \"teste_intrusao\",\n \"superficie\": \"servidor\",\n \"atividade_id\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "One vulnerability (with description and notes)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/vulnerabilidades/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "vulnerabilidades", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": " Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators)." } }, { "name": "Update a vulnerability", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/operacao/vulnerabilidades/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "operacao", "vulnerabilidades", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Same fields as creation (only those sent change). Fixed, accepted or false positive close it with the resolution date. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators).", "body": { "mode": "raw", "raw": "{\n \"estado\": \"corrigida\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Segurança da plataforma", "item": [ { "name": "Sign-in shield panel (24 h)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca" ] }, "description": "Reserved to platform management (403 for everyone else, including clinic administrators). Global infrastructure tables." } }, { "name": "Block an address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/bloquear", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "bloquear" ] }, "description": "hours 0 or missing = until someone unblocks it. Never the requester’s own address.", "body": { "mode": "raw", "raw": "{\n \"ip\": \"203.0.113.7\",\n \"horas\": 48,\n \"nota\": \"Rede de robôs\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Account sheet (blind index of the email)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/conta/:conta", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "conta", ":conta" ], "variable": [ { "key": "conta", "value": "1" } ] }, "description": "" } }, { "name": "Unblock an address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/desbloquear", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "desbloquear" ] }, "description": "" } }, { "name": "Release an account from its wait", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/libertar", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "libertar" ] }, "description": "The failure count restarts; logged in the audit." } }, { "name": "Origin (address) sheet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/origem", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "origem" ], "query": [ { "key": "ip", "value": "", "disabled": false } ] }, "description": "" } }, { "name": "Save the shield policy", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/seguranca/politica", "host": [ "{{base_url}}" ], "path": [ "plataforma", "seguranca", "politica" ] }, "description": "Fields: ativo, bits_base (12–22), limite_anomalo, limite_ataque, conta_livres, espera_base (s), espera_maxima (s), janela_conta (min), bloqueio_tentativas, bloqueio_horas, dispositivo_dias, aviso_dispositivo_novo, alerta_emails (list), escudo_dias. Platform values (stored on clinic 1).", "body": { "mode": "raw", "raw": "{\n \"bits_base\": 17,\n \"limite_anomalo\": 20,\n \"limite_ataque\": 60\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Superadministradores", "item": [ { "name": "List superadministrators", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins" ], "query": [ { "key": "f[estado]", "value": "", "disabled": true } ] }, "description": "Superadministrators with an active second factor only. Other accounts: 403 so_superadmin (or segundo_fator_necessario)." } }, { "name": "Create (platform-only account with invitation) or promote", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins" ] }, "description": "Reason required; audited; the other superadministrators receive an email. Promoting ends the person's sessions.", "body": { "mode": "raw", "raw": "{\n \"modo\": \"novo\",\n \"nome\": \"Tiago Lopes\",\n \"email\": \"tiago@anagen.pt\",\n \"motivo\": \"Responsável técnico da plataforma.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Team members who can be promoted", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins/candidatos", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins", "candidatos" ] }, "description": "" } }, { "name": "Detail with history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Edit name, email, phone and language (reason required)", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins/:id", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Suspend, reactivate, end sessions, reset 2FA, remove status, delete or resend invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/plataforma/superadmins/:id/:acao", "host": [ "{{base_url}}" ], "path": [ "plataforma", "superadmins", ":id", ":acao" ], "variable": [ { "key": "id", "value": "1" }, { "key": "acao", "value": "1" } ] }, "description": "Reason required (except convite). Never on your own account (409 proprio) nor on the last active superadministrator (409 ultimo_superadmin). Audited; email to the other superadministrators.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Saída da empresa.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Portal — acessos", "item": [ { "name": "Who accessed my data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/acessos", "host": [ "{{base_url}}" ], "path": [ "portal", "acessos" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "acao", "value": "", "disabled": true }, { "key": "pessoa", "value": "", "disabled": true }, { "key": "minhas", "value": "", "disabled": true }, { "key": "pagina", "value": "", "disabled": true } ] }, "description": "Source: Auditoria::acessosAoPaciente (immutable log). By default without the patient's own actions (minhas=1 includes them). Summary, chart per day (90 days), people and paginated accesses (25). The reason only appears for emergency accesses." } } ] }, { "name": "Portal — autenticação", "item": [ { "name": "Request a sign-in code by email", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/auth/codigo", "host": [ "{{base_url}}" ], "path": [ "portal", "auth", "codigo" ] }, "description": "The response is the same whether or not the account exists (does not reveal who is a patient).", "auth": { "type": "noauth" } } }, { "name": "Consents to show on registration", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/auth/consentimentos", "host": [ "{{base_url}}" ], "path": [ "portal", "auth", "consentimentos" ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Portal sign-in (code or password)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/auth/entrar", "host": [ "{{base_url}}" ], "path": [ "portal", "auth", "entrar" ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Create a portal account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/auth/registar", "host": [ "{{base_url}}" ], "path": [ "portal", "auth", "registar" ] }, "description": "Creates a pending account and sends a verification email (the account is only active once confirmed). Consents are those returned by GET /portal/auth/consentimentos; mandatory ones must be accepted.", "auth": { "type": "noauth" } } } ] }, { "name": "Portal — autorizações", "item": [ { "name": "Permissions: status, pending and history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/consentimentos", "host": [ "{{base_url}}" ], "path": [ "portal", "consentimentos" ] }, "description": "Status per purpose (latest decision), templates to sign (requested by the clinic in portal.consentimentos_pedidos, new versions and the surgical consent of the current episode) and immutable history." } }, { "name": "Consent template text", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/consentimentos/modelos/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "consentimentos", "modelos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Give or refuse a consent", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/consentimentos/modelos/:id/decidir", "host": [ "{{base_url}}" ], "path": [ "portal", "consentimentos", "modelos", ":id", "decidir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With a reflection period: requires the reading and the end of the period (409 «reflexao»). Written-consent purposes require the PNG signature. Immutable core row with channel, version and text hash. Effects: notice to doctor/reception for mandatory, surgical and refused consents.", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"dado\",\n \"assinatura\": \"data:image/png;base64,iVBORw0KGgo…\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm receipt of the information", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/consentimentos/modelos/:id/ler", "host": [ "{{base_url}}" ], "path": [ "portal", "consentimentos", "modelos", ":id", "ler" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records delivery of the information (portal_leituras «informacao_consentimento», once) and starts the template reflection period." } }, { "name": "Withdraw an optional permission", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/consentimentos/:finalidade/revogar", "host": [ "{{base_url}}" ], "path": [ "portal", "consentimentos", ":finalidade", "revogar" ], "variable": [ { "key": "finalidade", "value": "1" } ] }, "description": "New «revoked» row (the record is never deleted) with immediate effect: Conformidade\\Revogacao::aplicar (M2) or, without it, stopping CRM sequences and withdrawing communication images. Mandatory, clinical treatment and surgical: 409 «nao_revogavel». Effects: notice to administration, portal.consentimento_revogado webhook.", "body": { "mode": "raw", "raw": "{\n \"motivo\": null\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Portal · Cuidados por fase", "item": [ { "name": "Available and upcoming content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/cuidados", "host": [ "{{base_url}}" ], "path": [ "portal", "cuidados" ] }, "description": "Day since surgery (follow-up calendar), content already available (newest first, «novo» until opened) and upcoming items with date. 403 funcionalidade_desativada when recovery is turned off." } }, { "name": "Open one content item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/cuidados/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "cuidados", ":id" ], "variable": [ { "key": "id", "value": "4" } ] }, "description": "Sanitised text and video through a signed link (60 min). Only content already available and approved; opening records the view." } } ] }, { "name": "Portal — os meus dados", "item": [ { "name": "My details, preferences and requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/dados", "host": [ "{{base_url}}" ], "path": [ "portal", "dados" ] }, "description": "" } }, { "name": "Report or remove an allergy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/alergias", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "alergias" ] }, "description": "«alergias» request encrypted with the clinical key, validated by whoever can edit the clinical record. «alta» severity creates a high-priority task (portal.departamento_alergias).", "body": { "mode": "raw", "raw": "{\n \"acao\": \"acrescentar\",\n \"descricao\": \"Penicilina\",\n \"gravidade\": \"alta\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Propose a contact update", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/contactos", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "contactos" ] }, "description": "Creates a «contactos» request to validate (before → after, encrypted). The record only changes when the team accepts it in the portal_pedidos resource. Effects: task for portal.departamento_dados, portal.pedido_criado webhook.", "body": { "mode": "raw", "raw": "{\n \"telefone\": \"+351913000111\",\n \"morada\": \"Rua Nova, 5\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request account deletion", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/eliminar-conta", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "eliminar-conta" ] }, "description": "confirmar = true. The account becomes «eliminacao_pedida», all sessions and tokens end, a confirmation email is sent and an «eliminar_conta» request (legal deadline) goes to administration. The clinical record and invoicing are kept for the legal periods.", "body": { "mode": "raw", "raw": "{\n \"confirmar\": true,\n \"motivo\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Portability: export my data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/dados/exportar", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "exportar" ] }, "description": "Structured JSON (anagensys.portabilidade.v1 format): data subject, allergies, preferences, account, consents, appointments, documents, payments, invoices, messages and requests. «exportar» audit and portability request completed." } }, { "name": "Set or change the password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/palavra-passe", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "palavra-passe" ] }, "description": "Requires the current one when set; core password policy. Increases the session version and revokes all tokens (the app signs in again).", "body": { "mode": "raw", "raw": "{\n \"atual\": \"••••••••••\",\n \"nova\": \"••••••••••••\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Exercise a data subject right", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/pedidos", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "pedidos" ] }, "description": "Access, rectification, erasure, objection or restriction (portability: use GET /portal/dados/exportar). Legal deadline of 30 days; forwarded to pedidos_titulares (M2) when present; high-priority task for portal.departamento_rgpd. One open request per type (409).", "body": { "mode": "raw", "raw": "{\n \"tipo\": \"acesso\",\n \"descricao\": \"Pedido de cópia do processo clínico.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Communication and language preferences", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/dados/preferencias", "host": [ "{{base_url}}" ], "path": [ "portal", "dados", "preferencias" ] }, "description": "Immediate effect (portal_contas.preferencias and pacientes.idioma). marketing records a «given» consent or the revocation.", "body": { "mode": "raw", "raw": "{\n \"idioma\": \"en\",\n \"canal_preferido\": \"email\",\n \"lembretes\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Portal — documentos", "item": [ { "name": "Documents, forms and uploads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/documentos", "host": [ "{{base_url}}" ], "path": [ "portal", "documentos" ] }, "description": "Shared documents (documentos.partilhado_paciente and files shared by the team), to sign, uploaded by the patient and requested forms (to fill in)." } }, { "name": "Upload a document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/documentos", "host": [ "{{base_url}}" ], "path": [ "portal", "documentos" ] }, "description": "PDF, image or document; real type checked by content, executable extensions refused, random name, stored encrypted outside the public root (core Files). Effects: task for portal.departamento_documentos, timeline, portal.documento_enviado webhook." } }, { "name": "Shared document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/documentos/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "documentos", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "With signed links (view and download, 15 min); the first opening is recorded." } }, { "name": "Sign a document on screen", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/documentos/:id/assinar", "host": [ "{{base_url}}" ], "path": [ "portal", "documentos", ":id", "assinar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only «sent» documents awaiting signature. Stores the signature (PNG) and sets «signed» (assinatura_tipo «ecra»). Effects: notice to the issuer, timeline, «assinar» audit.", "body": { "mode": "raw", "raw": "{\n \"aceito\": true,\n \"assinatura\": \"data:image/png;base64,iVBORw0KGgo…\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Form requested from the patient", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/formularios/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "formularios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Normalised schema (sections and fields) of the M1 form still to fill in and within the deadline." } }, { "name": "Answer a form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/formularios/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "formularios", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Through the M1 form engine (Clinica\\Formularios::submeter): validation against the request version (questions, conditions, types), «tratamento_clinico» consent — and «fotografias_clinicas» with photos — already given or declared in «consentimentos» (otherwise per-field 422 «consentimentos.»), only photos uploaded for this request, encrypted answers, score, alarms, alerts awaiting validation and formulario.respondido webhook; status «por_validar». The GET also returns, as compatible additions, «esquema» (request version), «valores», «consentimentos» and «devolucao_motivo». Effects: notice to the episode doctor, timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"respostas\": {\n \"anticoagulantes\": \"nao\"\n },\n \"consentimentos\": {\n \"tratamento_clinico\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Photo for a form question", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/formularios/:id/ficheiros", "host": [ "{{base_url}}" ], "path": [ "portal", "formularios", ":id", "ficheiros" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Multipart «ficheiro» (images only, 15 MB, real type from the bytes, encrypted, tied to this request) and «consentimento_fotos» = 1 when the photo authorisation was ticked now; without it (and no consent already given) 422 on «ficheiro». Returns the identifier to use in the answer." } } ] }, { "name": "Portal — fotografias", "item": [ { "name": "Protocol, requests and photos", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/fotos", "host": [ "{{base_url}}" ], "path": [ "portal", "fotos" ] }, "description": "«portal» protocol views (or the six default views) with instructions and outline, requests per milestone, photos sent and shared by the doctor (never simulations), and the quality limits." } }, { "name": "Send a photo for a view", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/fotos", "host": [ "{{base_url}}" ], "path": [ "portal", "fotos" ] }, "description": "Light (mean 0–255) and focus (Laplacian standard deviation) checked on the server with the Settings limits; outside → 422, unless forcar = 1. Encrypted clinical file without EXIF/GPS; row in «fotos» (origin portal, to check) and milestone set to «fotos_enviadas». Effects: one notice per day to portal.departamento_fotos, timeline, portal.fotos_enviadas webhook." } } ] }, { "name": "Portal — início", "item": [ { "name": "Portal home summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/inicio", "host": [ "{{base_url}}" ], "path": [ "portal", "inicio" ] }, "description": "Next appointment, recovery stage and progress, counters (messages, documents, permissions, photos, notifications), balance, journey and latest updates. Each block is empty (null) when the feature is switched off by the clinic or the module does not exist yet." } }, { "name": "Patient updates (notifications)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/novidades", "host": [ "{{base_url}}" ], "path": [ "portal", "novidades" ], "query": [ { "key": "pagina", "value": "", "disabled": true }, { "key": "por_pagina", "value": "", "disabled": true }, { "key": "por_ler", "value": "", "disabled": true } ] }, "description": "Patient notifications, newest first, with links for web and app. No clinical content. meta.por_ler and meta.contadores for menu badges." } } ] }, { "name": "Portal — marcações", "item": [ { "name": "Patient appointments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes" ] }, "description": "Upcoming (ascending) and past (descending), with the actions allowed by the policy (pode_confirmar, pode_alterar, pode_cancelar, limite_alteracao) and the video consultation status." } }, { "name": "Book a free slot", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/marcacoes", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes" ] }, "description": "The time must be one of the slots returned by GET /portal/marcacoes/vagas (checked again on the server). Created by Agenda\\Marcacoes::criar (conflicts, schedules, margins) with origin «portal». Effects: reception notice, timeline, audit; M6 fires marcacao.criada.", "body": { "mode": "raw", "raw": "{\n \"tipo_id\": 3,\n \"inicio\": \"2026-11-04T10:30:00+00:00\",\n \"profissional_id\": 7,\n \"notas\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Types bookable online", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/tipos", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", "tipos" ] }, "description": "Active types with «online» on (never surgeries); video consultations only if the feature is on." } }, { "name": "Free slots for a type", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/vagas", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", "vagas" ], "query": [ { "key": "tipo_id", "value": "", "disabled": false }, { "key": "de", "value": "", "disabled": false }, { "key": "ate", "value": "", "disabled": true }, { "key": "profissional_id", "value": "", "disabled": true } ] }, "description": "Slots between two dates (max 45 days, never in the past, with the minimum notice portal.marcar_antecedencia_horas). Source: Agenda\\Marcacoes::disponibilidade." } }, { "name": "Appointment detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Cancel within the policy", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/:id/cancelar", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", ":id", "cancelar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Until limite_alteracao (type notice or portal.alterar_antecedencia_horas). After that: 409 «fora_da_politica». Effects: reception notice, timeline, audit.", "body": { "mode": "raw", "raw": "{\n \"motivo\": \"Viagem de trabalho\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm attendance", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/:id/confirmar", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", ":id", "confirmar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only future «booked» appointments → «confirmed» (confirmada_em, portal channel)." } }, { "name": "Reschedule to another slot", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/:id/remarcar", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", ":id", "remarcar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Creates the new appointment (same rules as POST /portal/marcacoes) with remarcada_de and closes the previous one as «rescheduled». Returns the new appointment.", "body": { "mode": "raw", "raw": "{\n \"inicio\": \"2026-11-06T15:00:00+00:00\",\n \"profissional_id\": 7\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enter the video consultation waiting room", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/marcacoes/:id/teleconsulta", "host": [ "{{base_url}}" ], "path": [ "portal", "marcacoes", ":id", "teleconsulta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The room opens portal.teleconsulta_minutos_antes before the time. Sets the consultation to «sala_espera», notifies the doctor and returns the room https address (M6 video provider). 409 «sala_por_preparar» if the room does not exist yet." } } ] }, { "name": "Portal — mensagens", "item": [ { "name": "Conversation with the team", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/mensagens", "host": [ "{{base_url}}" ], "path": [ "portal", "mensagens" ], "query": [ { "key": "desde", "value": "", "disabled": true } ] }, "description": "«portal» channel messages (incoming and outgoing — never internal notes), oldest first; with ?desde= only new ones. Opening marks team messages as read. Includes the stated reply time." } }, { "name": "Send a message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/mensagens", "host": [ "{{base_url}}" ], "path": [ "portal", "mensagens" ] }, "description": "Body 2–4000 characters; up to 5 attachments uploaded first to /portal/mensagens/anexos. Entered through Crm\\Conversas::registarEntrada (triage, SLA, assignment); without it, stored in the conversation and reception is notified. urgente = true creates an urgent task (portal.departamento_urgencias).", "body": { "mode": "raw", "raw": "{\n \"corpo\": \"Bom dia, posso lavar a cabeça amanhã?\",\n \"anexos\": [],\n \"urgente\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Upload an attachment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/mensagens/anexos", "host": [ "{{base_url}}" ], "path": [ "portal", "mensagens", "anexos" ] }, "description": "Image, PDF or document up to 15 MB, encrypted; returns the id to use in «anexos»." } } ] }, { "name": "Portal — pagamentos", "item": [ { "name": "Balance, payments and invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/pagamentos", "host": [ "{{base_url}}" ], "path": [ "portal", "pagamentos" ] }, "description": "Balance (accepted proposals − payments received), payments (with Multibanco reference when present) and issued invoices with the PDF. Available methods: those in portal.pagamentos_metodos with the payment service active." } }, { "name": "Pay (MB WAY, Multibanco or link)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/pagamentos", "host": [ "{{base_url}}" ], "path": [ "portal", "pagamentos" ] }, "description": "A pending payment (pagamento_id) or a free amount up to the balance due (valor). MB WAY requires a Portuguese mobile (9 digits). A still-valid Multibanco reference is returned without creating another. Comercial\\Pagamentos::criar (M5) creates the reference/request/link; the portal never receives card data.", "body": { "mode": "raw", "raw": "{\n \"pagamento_id\": 204,\n \"metodo\": \"mbway\",\n \"telefone\": \"912345678\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Portal — propostas e pagamentos", "item": [ { "name": "Pay", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/pagamentos/:id/pagar", "host": [ "{{base_url}}" ], "path": [ "portal", "pagamentos", ":id", "pagar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"metodo\": \"mbway\",\n \"telefone\": \"912345678\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "My proposals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/propostas", "host": [ "{{base_url}}" ], "path": [ "portal", "propostas" ] }, "description": "Only proposals sent to the patient themself (never drafts)." } }, { "name": "Decline", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/propostas/:id/recusar", "host": [ "{{base_url}}" ], "path": [ "portal", "propostas", ":id", "recusar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Portal — plano", "item": [ { "name": "My plan: approved plans, 3D models and proposals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/plano", "host": [ "{{base_url}}" ], "path": [ "portal", "plano" ] }, "description": "Only what the doctor shared: plans with status «approved» (no clinical notes), 3D models whose file is shared, and sent proposals. Switches: portal.mostrar_plano, _modelo3d, _simulacao, _propostas." } }, { "name": "Link to the shared 3D model", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/plano/modelos3d/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "plano", "modelos3d", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Returns a 30-minute signed link to the file (GLB, PLY, OBJ, STL or USDZ). The access is audited." } }, { "name": "Accept the simulation notice and get the image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/plano/:id/simulacao", "host": [ "{{base_url}}" ], "path": [ "portal", "plano", ":id", "simulacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records acknowledgement of «Illustrative, with no guarantee of results» (planos.simulacao_aviso_aceite_em, proof in portal_leituras and audit) and returns the plan with simulacao.url (15 min). Effects: patient timeline." } }, { "name": "Proposal detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/propostas/:id", "host": [ "{{base_url}}" ], "path": [ "portal", "propostas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Lines, options, totals, instalments and PDF. The first opening marks the proposal as «viewed» (vista_em) and records the reading." } }, { "name": "Accept a proposal with signature", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/portal/propostas/:id/aceitar", "host": [ "{{base_url}}" ], "path": [ "portal", "propostas", ":id", "aceitar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires aceito = true, the signature (PNG in base64 or data URL) and the option when the proposal has options. Uses Comercial\\Propostas::aceitar when available; otherwise records the acceptance, processes commissions and fires the proposta.aceite webhook. Effects: notification to the sales owner, timeline, «assinar» audit.", "body": { "mode": "raw", "raw": "{\n \"aceito\": true,\n \"assinatura\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…\",\n \"opcao\": null\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Portal — recuperação", "item": [ { "name": "Recovery timeline and instructions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/recuperacao", "host": [ "{{base_url}}" ], "path": [ "portal", "recuperacao" ] }, "description": "Surgery, milestones (marcos_acompanhamento or calculated calendar), current stage, progress, stage content (knowledge base, site blocks or general guidance; videos only from the clinic itself) and discharge instructions (no medication)." } }, { "name": "Content of a stage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/portal/recuperacao/fases/:fase", "host": [ "{{base_url}}" ], "path": [ "portal", "recuperacao", "fases", ":fase" ], "variable": [ { "key": "fase", "value": "1" } ] }, "description": "" } } ] }, { "name": "Proposta pública", "item": [ { "name": "Proposal page (HTML)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "Shows the proposal with the branding and legal data of the clinic that owns it, in pt or en (proposal language or ?lingua=). First opening marks «vista». Invalid, revised or expired link → informative page.", "auth": { "type": "noauth" } } }, { "name": "Accept (form)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token/aceitar", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token", "aceitar" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "Form with CSRF and honeypot; limit of 8 submissions per 10 minutes. Verifies the seal, stores the proof and creates the payment plan.", "auth": { "type": "noauth" } } }, { "name": "Proposal payments status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token/estado", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token", "estado" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "Used by the page to follow MB WAY: list of payments (id, type, amount, status).", "auth": { "type": "noauth" } } }, { "name": "Pay the proposal's next payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token/pagar", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token", "pagar" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "Only this proposal's first unpaid payment, through the owning clinic's provider and credentials. Payment link → redirects to the provider page.", "auth": { "type": "noauth" } } }, { "name": "Proposal PDF", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token/pdf", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token", "pdf" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "", "auth": { "type": "noauth" } } }, { "name": "Decline (form)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/proposta/:token/recusar", "host": [ "{{base_url}}" ], "path": [ "proposta", ":token", "recusar" ], "variable": [ { "key": "token", "value": "1" } ] }, "description": "", "auth": { "type": "noauth" } } } ] }, { "name": "Apresentação do AnagenSys", "item": [ { "name": "AnagenSys presentation content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/apresentacao", "host": [ "{{base_url}}" ], "path": [ "publico", "apresentacao" ], "query": [ { "key": "lingua", "value": "", "disabled": true } ] }, "description": "No session. Returns every section of the product page in the requested language (pt or en; other languages get English), the demo form options, the time seal and the trap field name. Records an anonymous visit («apresentacao» area). Limit: 60 requests per minute per IP.", "auth": { "type": "noauth" } } }, { "name": "Request an AnagenSys demo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/publico/apresentacao/pedido", "host": [ "{{base_url}}" ], "path": [ "publico", "apresentacao", "pedido" ] }, "description": "No session. Validated by value lists, types and lengths; contact consent is required. Protections: 5 submissions per 10 minutes per IP, hourly limit in settings, time seal (_selo) and empty trap field — a bot gets 201 with nothing stored (null id). Effects: request on the platform board, notification and email alert, confirmation email to the requester and «demonstracao.pedida» webhook.", "body": { "mode": "raw", "raw": "{\n \"nome\": \"Marta Ribeiro\",\n \"clinica_nome\": \"Clínica Capilar do Norte\",\n \"cargo\": \"Diretora clínica\",\n \"email\": \"marta@capilarnorte.pt\",\n \"telefone\": \"+351 912 345 678\",\n \"pais\": \"PT\",\n \"especialidade\": \"capilar\",\n \"cirurgioes_n\": 2,\n \"cirurgias_mes\": 24,\n \"consentimento_contacto\": true,\n \"idioma\": \"pt\",\n \"_selo\": \"MTczMDEwOTYwMC5…\",\n \"website_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } } ] }, { "name": "Clínica pública", "item": [ { "name": "Resolved public clinic", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/clinica", "host": [ "{{base_url}}" ], "path": [ "publico", "clinica" ] }, "description": "By the X-AX-Clinica header (code) or by the request host (verified domains); falls back to the server public clinic.", "auth": { "type": "noauth" } } }, { "name": "Clinic by code (app choice)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/clinica/:codigo", "host": [ "{{base_url}}" ], "path": [ "publico", "clinica", ":codigo" ], "variable": [ { "key": "codigo", "value": "PORTO-HAIR" } ] }, "description": "Public data only. 30 requests per minute per IP. disponivel = false when the licence blocks the clinic.", "auth": { "type": "noauth" } } } ] }, { "name": "Formulários por ligação", "item": [ { "name": "Form, schema and pre-fill", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/formularios/:token", "host": [ "{{base_url}}" ], "path": [ "publico", "formularios", ":token" ], "variable": [ { "key": "token", "value": "q3V9k1sXw7bE2mN4tR8yU0pL6aZ5cH1dF9gJ3kM2nB4" } ] }, "description": "No authentication. The host clinic (or the X-AX-Clinica header) is resolved first, but the request record defines the clinic. Only «pendente» requests within the deadline (past it they become «expirado»); otherwise 404 «ligacao_invalida». Returns the schema of the request version, the pre-fill values (the patient previous responses to the same form, without photos nor signatures), the deadline, the information request when the response was returned and the clinic name. Compatible additions: «consentimentos» (missing authorisations, to show as boxes never pre-ticked), «aviso» (privacy notice in force for the «formulario» channel, with the token to return on submit) and «armadilha» (name of the field that must be sent empty). Limit: 60 requests per 10 minutes per IP address, reads included (429 with Retry-After).", "auth": { "type": "noauth" } } }, { "name": "Submit the answers", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/publico/formularios/:token", "host": [ "{{base_url}}" ], "path": [ "publico", "formularios", ":token" ], "variable": [ { "key": "token", "value": "q3V9k1sXw7bE2mN4tR8yU0pL6aZ5cH1dF9gJ3kM2nB4" } ] }, "description": "No authentication (Idempotency-Key does not apply). Answers validated against the request version schema (same rules as POST /formularios/{id}/respostas; errors → 422 with the question key). Photo questions only accept files uploaded for this request. The response is always «por_validar» («paciente» source) and the token stops working. The patient only gets a receipt — never the score nor the alarms. Effects: encrypted answers, alerts awaiting validation, alarm → urgent task and notice to the department, pre-assessment → medical review task, timeline, audit, formulario.respondido webhook. Consent required before saving: «tratamento_clinico» (and «fotografias_clinicas» when there are photos) already recorded or declared in «consentimentos»; without it 422 with the per-field error «consentimentos.» and nothing is saved (the answers stay on screen). Declarations are recorded immutably («formulario_site» channel). With «aviso_testemunho», the privacy notice version shown is recorded. Trap field filled → 201 with a null resposta_id and nothing saved. Limit: 10 requests per 10 minutes per IP address (429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"respostas\": {\n \"anticoagulantes\": \"sim\",\n \"qual_anticoagulante\": \"Apixabano 5 mg\",\n \"impacto\": 7\n },\n \"idioma\": \"pt-PT\",\n \"consentimentos\": {\n \"tratamento_clinico\": true\n },\n \"aviso_testemunho\": \"eyJhIjo0LCJ2IjoyfQ.…\",\n \"honeypot\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Upload the photo of a question", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/formularios/:token/ficheiros", "host": [ "{{base_url}}" ], "path": [ "publico", "formularios", ":token", "ficheiros" ], "variable": [ { "key": "token", "value": "q3V9k1sXw7bE2mN4tR8yU0pL6aZ5cH1dF9gJ3kM2nB4" } ] }, "description": "No authentication. Images only, up to 15 MB: real type checked from the bytes, executable extensions refused, random name, stored outside the public area as a clinical file of the patient and tied to this request. No photo is collected before the «fotografias_clinicas» authorisation (already recorded or declared with consentimento_fotos = 1; otherwise 422 on «ficheiro»), as on the web page. Returns the identifier to use in the photo question answer. Missing or invalid file → 422. Limit: 30 requests per 10 minutes per IP address (429 with Retry-After).", "auth": { "type": "noauth" } } } ] }, { "name": "Pré-avaliação online", "item": [ { "name": "The clinic's online assessment form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/pre-avaliacao", "host": [ "{{base_url}}" ], "path": [ "publico", "pre-avaliacao" ], "query": [ { "key": "lingua", "value": "", "disabled": true } ] }, "description": "No session. Questions (from the clinic's clinical form when present, otherwise the base questions), photo views, consents (always unticked), limits, texts and seal. Limit: 60 per minute per IP.", "auth": { "type": "noauth" } } }, { "name": "Submit the online assessment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/publico/pre-avaliacao", "host": [ "{{base_url}}" ], "path": [ "publico", "pre-avaliacao" ] }, "description": "No session. Required consents are checked before any data is stored. Answers are validated against the schema questions; photos are the tokens returned by POST /publico/pre-avaliacao/fotos (valid 24 h, same clinic). Effects: lead (online assessment source), consents recorded, encrypted answers, linked photos, medical review task, timeline, confirmation email without clinical content and «pre_avaliacao.recebida» webhook. The response never reveals the clinical triage: «triagem» is only «revisao» or «consulta». Limit: 5 per 10 minutes per IP.", "body": { "mode": "raw", "raw": "{\n \"lingua\": \"pt\",\n \"respostas\": {\n \"nome\": \"João Costa\",\n \"email\": \"joao.costa@exemplo.pt\",\n \"telefone\": \"+351 913 222 111\",\n \"pais\": \"PT\",\n \"idade\": 34,\n \"area\": \"couro_cabeludo\",\n \"tempo_queda\": \"3_5\",\n \"cirurgia_anterior\": \"nao\",\n \"tratamentos\": [\n \"minoxidil\"\n ]\n },\n \"consentimentos\": {\n \"tratamento_clinico\": true,\n \"fotografias_clinicas\": true,\n \"contacto\": true,\n \"marketing\": false\n },\n \"fotos\": [\n \"ODgwMS5mcm9udGFsLjE3MzAy…\",\n \"ODgwMi50b3BvLjE3MzAy…\",\n \"ODgwMy5kYWRvcmEuMTczMDI…\"\n ],\n \"_selo\": \"MTczMDEwOTYwMC5…\",\n \"website_url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "auth": { "type": "noauth" } } }, { "name": "Upload an online assessment photo", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/publico/pre-avaliacao/fotos", "host": [ "{{base_url}}" ], "path": [ "publico", "pre-avaliacao", "fotos" ] }, "description": "No session, multipart. Only accepted with consentimento_fotos = 1. The real type is checked from the bytes; the file is encrypted with the clinical key and stored outside the public area with a random name. Returns a signed token (24 h) to include in «fotos» on submission. Unused photos are deleted automatically. Limit: 40 per hour per IP.", "auth": { "type": "noauth" } } } ] }, { "name": "Reuniões", "item": [ { "name": "Approve an action (creates the task)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reunioes/:id/acoes/:acao/aprovar", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "acoes", ":acao", "aprovar" ], "variable": [ { "key": "id", "value": "12" }, { "key": "acao", "value": "12" } ] }, "description": "Creates the task with the chosen owner and deadline. The title is the one sent in «titulo» or a neutral title with the meeting name — the (encrypted) action text is not copied to the task. Also requires equipa.tarefas edit.", "body": { "mode": "raw", "raw": "{\n \"responsavel_id\": 9,\n \"prazo\": \"2026-11-03\",\n \"titulo\": \"Rever o stock de agulhas\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject an action", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/acoes/:acao/rejeitar", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "acoes", ":acao", "rejeitar" ], "variable": [ { "key": "id", "value": "12" }, { "key": "acao", "value": "12" } ] }, "description": "" } }, { "name": "Upload an audio part", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/audio", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "audio" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Numbered part (16 kHz mono WAV recommended; MP3, M4A, OGG and WEBM accepted; up to 25 MB and 15 min). Requires a recorded/transcribed meeting with notice, at least one attendee and ALL consenting. The part is encrypted at rest and transcribed immediately (local service first; external service only when allowed for team data). Audio is deleted after the configured period. Repeated parts are ignored (repetida=true)." } }, { "name": "My recording decision", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reunioes/:id/consentir", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "consentir" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "The participant gives, refuses or withdraws consent. A refusal or withdrawal blocks new audio parts. Recorded with date, origin and IP.", "body": { "mode": "raw", "raw": "{\n \"consentimento\": \"dado\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record another person’s attendance and decision", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reunioes/:id/presencas", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "presencas" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "The organiser records the decision stated in the room by a colleague (utilizador_id) or an external guest (name, stored encrypted).", "body": { "mode": "raw", "raw": "{\n \"utilizador_id\": 9,\n \"consentimento\": \"dado\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Save (and validate) the summary", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/reunioes/:id/resumo", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "resumo" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"resumo\": \"Revisão da agenda…\",\n \"validar\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ask the Assistant for summary and actions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/resumo/propor", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "resumo", "propor" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "From the transcript (and notes), returns a summary with decisions and creates the proposed actions (text, owner and deadline when stated). Stays a PROPOSAL until human validation. 503 when the Assistant is unavailable." } }, { "name": "Meeting state (recording, attendance, summary, actions)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/sessao", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "sessao" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Everything the meeting screen needs, WITHOUT the transcript text (read separately, audited). Access: participant, organiser or manager (equipa.chat edit with «all» scope)." } }, { "name": "Read the transcript", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/transcricao", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "transcricao" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Transcript text (decrypted). Each read is audited." } }, { "name": "Discard the transcript", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/reunioes/:id/transcricao", "host": [ "{{base_url}}" ], "path": [ "reunioes", ":id", "transcricao" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Deletes the text and any audio still stored. The validated summary and decided actions are kept. Organiser or manager only." } } ] }, { "name": "Site — analytics", "item": [ { "name": "Website statistics and cookie decisions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/analytics", "host": [ "{{base_url}}" ], "path": [ "site", "analytics" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true }, { "key": "area", "value": "", "disabled": true } ] }, "description": "Own measurement without cookies: visits, anonymous sessions (daily encrypted digest), pages, sources, campaigns, devices, languages, conversions and cookie decisions, with change versus the previous period. Up to 366 days; default is the last 30." } }, { "name": "Live visits and cookie decisions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/analytics/ao-vivo", "host": [ "{{base_url}}" ], "path": [ "site", "analytics", "ao-vivo" ], "query": [ { "key": "minutos", "value": "", "disabled": true } ] }, "description": "Last minutes (5 to 1440; default 60). Designed for refreshing every 15 seconds." } } ] }, { "name": "Site — CMS", "item": [ { "name": "Editable blocks of a page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/blocos", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "blocos" ], "query": [ { "key": "pagina", "value": "", "disabled": false }, { "key": "idioma", "value": "", "disabled": true } ] }, "description": "Catalogue and saved values, in page order. The «apresentacao» page is refused (403): it is managed in the platform area." } }, { "name": "Save a block", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/cms/blocos", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "blocos" ] }, "description": "Validated by type: text up to 500 characters; long text up to 12,000; HTML sanitised by tag allowlist; link with https://, mailto:, tel: or a website path; list up to 200 items; image with a library ficheiro_id. Change is audited; the website updates immediately.", "body": { "mode": "raw", "raw": "{\n \"pagina\": \"inicio\",\n \"chave\": \"hero_titulo\",\n \"idioma\": \"pt\",\n \"valor\": \"Cabelo natural, *plano transparente*.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restore a block's original text", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/cms/blocos/repor", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "blocos", "repor" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"pagina\": \"inicio\",\n \"chave\": \"hero_titulo\",\n \"idioma\": \"pt\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Website image library", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/imagens", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "imagens" ], "query": [ { "key": "q", "value": "", "disabled": true } ] }, "description": "" } }, { "name": "Upload an image", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/imagens", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "imagens" ] }, "description": "Multipart. Only JPEG, PNG, WebP or GIF checked by bytes and dimensions; rewritten without metadata (max 2400 px), random name, public folder with execution disabled. Limit: 60 per 10 minutes." } }, { "name": "Change an image's descriptions", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/cms/imagens/:id", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "imagens", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"alt_pt\": \"Sala de consulta\",\n \"alt_en\": \"Consultation room\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an unused image", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/imagens/:id", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "imagens", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Refused (422) if the image is used in a block or page." } }, { "name": "The clinic's website pages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/paginas", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "paginas" ] }, "description": "All pages of the current clinic with status per language and number of customised blocks." } }, { "name": "Publish or unpublish a page", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/cms/paginas/:id/publicar", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "paginas", ":id", "publicar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "publicar = true (default) publishes; false removes it from the website. With new content, an immutable version with a fingerprint (SHA-256) is created. Publishing the Cookie Policy increases the policy version and the banner asks again.", "body": { "mode": "raw", "raw": "{\n \"publicar\": true,\n \"motivo\": \"Atualização dos dados do encarregado de proteção de dados\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Published versions of a page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/cms/paginas/:id/versoes", "host": [ "{{base_url}}" ], "path": [ "site", "cms", "paginas", ":id", "versoes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Site — incorporação", "item": [ { "name": "Assessment on other websites: status and code", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/incorporacao", "host": [ "{{base_url}}" ], "path": [ "site", "incorporacao" ] }, "description": "Authorised websites, the line of code to paste (Portuguese, English and with container) and the embedded page and preview addresses. The embedded page can only be framed by the authorised websites (frame-ancestors) and only sends height messages to the validated origin." } }, { "name": "Switch on and authorise websites", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/incorporacao", "host": [ "{{base_url}}" ], "path": [ "site", "incorporacao" ] }, "description": "ativa switches embedding on (requires at least one website); dominios accepts https://domain, domain or *.domain (up to 20). An invalid address refuses the request (422). Change is audited.", "body": { "mode": "raw", "raw": "{\n \"ativa\": true,\n \"dominios\": [\n \"https://www.clinica.pt\",\n \"*.clinica.pt\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Site — pré-avaliações", "item": [ { "name": "Online assessment for review", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/site/pre-avaliacoes/:id", "host": [ "{{base_url}}" ], "path": [ "site", "pre-avaliacoes", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The list, filters and export come from the generic pre_avaliacoes resource (/r/pre_avaliacoes). This detail adds the photos (ficha.fotografias, 30-min links) and the answers, triage and medical note (ficha.clinica). The first opening by a reviewer sets the status to «em_revisao». Read is audited." } }, { "name": "Send the reply to the person", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/pre-avaliacoes/:id/resposta", "host": [ "{{base_url}}" ], "path": [ "site", "pre-avaliacoes", ":id", "resposta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires crm.atendimento (edit) and the «revista» status (422 before medical review). Sends the email with the next step for the opinion, without clinical details, and sets «respondida».", "body": { "mode": "raw", "raw": "{\n \"mensagem\": \"Temos vagas na próxima semana, de manhã.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Medical review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/site/pre-avaliacoes/:id/revista", "host": [ "{{base_url}}" ], "path": [ "site", "pre-avaliacoes", ":id", "revista" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires ficha.clinica (edit). Stores the opinion and the medical note (encrypted), completes the review task, validates the clinical form response and notifies reception (no clinical content).", "body": { "mode": "raw", "raw": "{\n \"parecer\": \"consulta\",\n \"nota\": \"Boa zona dadora; avaliar a coroa em consulta.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Stock", "item": [ { "name": "Stock alerts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/stock/alertas", "host": [ "{{base_url}}" ], "path": [ "stock", "alertas" ] }, "description": "" } }, { "name": "Consumption of a surgery", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/stock/cirurgias/:id/consumos", "host": [ "{{base_url}}" ], "path": [ "stock", "cirurgias", ":id", "consumos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } }, { "name": "Record consumption (Consumos::registarCirurgia)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/stock/cirurgias/:id/consumos", "host": [ "{{base_url}}" ], "path": [ "stock", "cirurgias", ":id", "consumos" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Idempotent per surgery: replaces consumption not yet posted. Requires a batch for items with mandatory batch. Effects: consumption stock-outs linked to the surgery and patient, minimum alerts.", "body": { "mode": "raw", "raw": "{\n \"linhas\": [\n {\n \"artigo_id\": 5,\n \"quantidade\": 2,\n \"lote\": \"L2611A\",\n \"validade\": \"2027-05-31\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Tarefas", "item": [ { "name": "Tasks by view", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas", "host": [ "{{base_url}}" ], "path": [ "tarefas" ], "query": [ { "key": "vista", "value": "", "disabled": true }, { "key": "q", "value": "", "disabled": true }, { "key": "prioridade", "value": "", "disabled": true }, { "key": "origem", "value": "", "disabled": true }, { "key": "responsavel_id", "value": "", "disabled": true }, { "key": "paciente_id", "value": "", "disabled": true }, { "key": "lead_id", "value": "", "disabled": true }, { "key": "cirurgia_id", "value": "", "disabled": true } ] }, "description": "Views: minhas (grouped overdue, today, upcoming, no due date), equipa (matrix scope), quadro (open, in progress, completed in the last 7 days) and concluidas.\n\nScope equipa.tarefas: «own» = mine, my department's unassigned ones and those I created; «team» adds my teams'; «all» = whole clinic. Patient, lead and surgery names only for those who may see those modules." } }, { "name": "Create task (with checklist)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tarefas", "host": [ "{{base_url}}" ], "path": [ "tarefas" ] }, "description": "Quick create: the title understands «!urgente|!alta|!baixa» (priority), «hoje»/«amanhã» (today/tomorrow at 18:00) and «@Name» (assignee). Without assignee or department, the task goes to its creator. The assignee (or department) is notified.\n\nEffects: webhook tarefa.criada; audit log.", "body": { "mode": "raw", "raw": "{\n \"titulo\": \"Pedir análises pré-operatórias amanhã !alta\",\n \"responsavel_id\": 4,\n \"paciente_id\": 41,\n \"itens\": [\n \"Hemograma\",\n \"Coagulação\",\n \"ECG\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Counts (today, overdue, open, team)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/contagens", "host": [ "{{base_url}}" ], "path": [ "tarefas", "contagens" ] }, "description": "" } }, { "name": "Get task with checklist", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/:id", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } }, { "name": "Update task", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tarefas/:id", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Partial update (only fields sent). «estado» accepts aberta, em_curso or cancelada; to complete use /concluir. Changing the assignee notifies the new person.", "body": { "mode": "raw", "raw": "{\n \"prazo\": \"2026-10-30T12:00:00+00:00\",\n \"estado\": \"em_curso\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Complete task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/:id/concluir", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "concluir" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "Refused (422) while required checklist items are pending. Effects: webhook tarefa.concluida; audit. Undo: /reabrir." } }, { "name": "Add checklist item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tarefas/:id/itens", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "itens" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"texto\": \"Confirmar jejum de 6 h\",\n \"responsavel_id\": 9,\n \"obrigatorio\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reorder the checklist", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tarefas/:id/itens/ordem", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "itens", "ordem" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n 7,\n 5,\n 6\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/:id/itens/:item", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "itens", ":item" ], "variable": [ { "key": "id", "value": "12" }, { "key": "item", "value": "12" } ] }, "description": "" } }, { "name": "Check/uncheck item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/:id/itens/:item/alternar", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "itens", ":item", "alternar" ], "variable": [ { "key": "id", "value": "12" }, { "key": "item", "value": "12" } ] }, "description": "Without body it toggles; with {\"feito\": true|false} it sets. Records who and when." } }, { "name": "Move to another board column", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tarefas/:id/mover", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "mover" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"estado\": \"em_curso\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reopen task (undo)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tarefas/:id/reabrir", "host": [ "{{base_url}}" ], "path": [ "tarefas", ":id", "reabrir" ], "variable": [ { "key": "id", "value": "12" } ] }, "description": "" } } ] }, { "name": "Teleconsulta", "item": [ { "name": "Teleconsultations of a day or range", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas", "host": [ "{{base_url}}" ], "path": [ "teleconsultas" ], "query": [ { "key": "data", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Within the «teleconsulta» module scope (doctor: their own and those of their patients), excluding cancelled or rescheduled appointments, by time (up to 200). «relatorio_ok» tells whether a report exists, without showing it." } }, { "name": "Teleconsultation detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Status, steps (consent, waiting room, admission, identity, attendees, report, closing), valid consents, attendees, host address of the video room (only to those who can run the session), captures, report and attendance-proof files and the clinic approved consent text to read to the patient. The report and captures are only returned to users with access to the patient clinical record («ficha.clinica»), with the read audited." } }, { "name": "Admit the patient and start the session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/admitir", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "admitir" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires a valid teleconsultation consent (422 «consentimento_em_falta»). Creates the room on the video service from Settings (once; the host address is stored encrypted; 503 «video_indisponivel» if the service fails) and starts the session: only from now on does the patient receive the room address. Ended or closed teleconsultation → 409. Effects: appointment in progress with check-in, appointment history and audit." } }, { "name": "Save a video consultation capture", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/captura", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "captura" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Image validated by content, random name, location metadata removed, stored as an encrypted clinical file of the patient; enters the clinical gallery as «to verify» when the planning module exists. Requires «teleconsulta» edit and access to the patient clinical record. Returns a 15-minute signed link." } }, { "name": "Record the consent given to the team", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/consentimento", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "consentimento" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records in the core consent registry (decision «given», approved version of the clinic template) the teleconsultation or recording consent given orally, in person, by email or on the portal. The patient can also give it when joining the waiting room. No patient → 422.", "body": { "mode": "raw", "raw": "{\n \"finalidade\": \"teleconsulta\",\n \"canal\": \"telefone\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Close the teleconsultation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/fechar", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "fechar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only closes with a report (422 «relatorio_em_falta»). Generates the report document (clinical, encrypted, shared with the patient) and the attendance proof (document from the documents module when it exists; otherwise its own file), marks the appointment as completed, records a clinical timeline event and notifies the patient that the report is available on the portal. Requires «teleconsulta» edit and clinical record access. Already closed → 409. Effects: audit." } }, { "name": "Share a file with the patient in the room", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/ficheiros", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "ficheiros" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Image, PDF or document (up to 25 MB), validated by content, stored encrypted as a clinical file and shown in the patient’s room for download." } }, { "name": "Stop showing a file to the patient", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/ficheiros/:linha/retirar", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "ficheiros", ":linha", "retirar" ], "variable": [ { "key": "id", "value": "1" }, { "key": "linha", "value": "1" } ] }, "description": "" } }, { "name": "Allow or prevent recording", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/gravacao", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "gravacao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Recording is off by default and can only be allowed with a valid recording consent (purpose «gravacao_video») — otherwise 422 «consentimento_em_falta». Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"permitir\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm the patient identity", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/identidade", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "identidade" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Records the method, who confirmed and when (session start). Effects: audit.", "body": { "mode": "raw", "raw": "{\n \"metodo\": \"documento\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record who is present", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/presentes", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "presentes" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Replaces the list (up to 12 people; rows without a name are ignored; unknown role becomes «outro»). Effects: audit (number of people only).", "body": { "mode": "raw", "raw": "{\n \"presentes\": [\n {\n \"nome\": \"Rui Almeida\",\n \"papel\": \"paciente\"\n },\n {\n \"nome\": \"Sofia Almeida\",\n \"papel\": \"acompanhante\",\n \"relacao\": \"Cônjuge\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Report draft by the Assistant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/proposta", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "proposta" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "The Assistant («escriba» use, models chosen in Settings › AI models) drafts a structured report from the doctor notes (reason, reported history, video observation, assessment, plan, next contact), without inventing data. Patient data only goes to the local service, unless the specific option for this use is on. Nothing is saved: the doctor reviews, corrects and saves with PUT /teleconsultas/{id}/relatorio. Without the Assistant configured it returns 200 with ok:false and «erro». Requires «teleconsulta» edit and clinical record access. Limit: 20 requests per 10 minutes.", "body": { "mode": "raw", "raw": "{\n \"notas\": \"Queda frontal 3 anos. Recessão bitemporal. Norwood III. Sem doenças. Faz minoxidil. Marcar presencial com tricoscopia em 2 semanas.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Save the report", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/relatorio", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "relatorio" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Saves the report (up to 20,000 characters), encrypted with the clinical key; the person saving becomes the validator. When the text comes from an Assistant draft, send ia_pedido_id, ia_fornecedor and ia_modelo exactly as returned by POST /teleconsultas/{id}/proposta (origin «assistente»). Requires «teleconsulta» edit and clinical record access. Closed teleconsultation → 409. Effects: audit (field names only).", "body": { "mode": "raw", "raw": "{\n \"relatorio\": \"Motivo: avaliação de queda de cabelo frontal com 3 anos de evolução.\\nObservação por vídeo: recessão bitemporal, padrão compatível com Norwood III.\\nAvaliação: candidato a avaliação presencial com tricoscopia.\\nPlano e recomendações: marcar consulta presencial; manter tratamento tópico.\\nPróximo contacto: consulta presencial em 2 semanas.\\nA consulta decorreu por videoconsulta.\",\n \"ia_pedido_id\": 5521\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Draft the report from the transcript", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/resumo", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "resumo" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Requires the «ia» consent. Nothing is saved: the doctor reviews and saves with PUT …/relatorio." } }, { "name": "End the call", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/terminar", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "terminar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Sets «terminada» and records the end time; the report can be written afterwards. Only from scheduled, waiting room or in progress (409 «estado_invalido»). Effects: audit." } }, { "name": "Session transcript text", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/transcricao", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "transcricao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Audited read; requires the patient clinical record." } }, { "name": "Transcribe a part of the session audio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/transcricao", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "transcricao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only with valid «gravacao_video» and «ia» consents and recording allowed. Part up to 25 MB and 15 minutes. Transcribed by the «teleconsulta_resumo» AI use (local service first); text appended to the encrypted transcript; audio never stored." } }, { "name": "Discard the transcript", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/teleconsultas/:id/transcricao/descartar", "host": [ "{{base_url}}" ], "path": [ "teleconsultas", ":id", "transcricao", "descartar" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Tricoscopia", "item": [ { "name": "Save a field", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tricoscopia", "host": [ "{{base_url}}" ], "path": [ "tricoscopia" ] }, "description": "Calculated values are always recalculated on the server. ponto: {x, y} on the diagram (0–1) or {x, y, z} on the 3D model.", "body": { "mode": "raw", "raw": "{\n \"paciente_id\": 1204,\n \"subzona\": \"occipital\",\n \"aparelho\": \"Dermatoscópio A\",\n \"ampliacao\": 20,\n \"area_campo_mm2\": 100,\n \"uf_1\": 18,\n \"uf_2\": 38,\n \"uf_3\": 17,\n \"uf_4\": 2,\n \"ponto\": {\n \"x\": 0.5,\n \"y\": 0.91\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Calculate a field (live, without saving)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tricoscopia/calcular", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "calcular" ] }, "description": "FU/cm² = FU ÷ (area mm² ÷ 100); hairs/cm²; hairs/FU; FU composition; thickness classes by counts; coverage value = calibre × hairs/cm²; warnings (calibre from fewer than 25 hairs, percentages not adding to 100).", "body": { "mode": "raw", "raw": "{\n \"area_campo_mm2\": 100,\n \"uf_1\": 18,\n \"uf_2\": 38,\n \"uf_3\": 17,\n \"uf_4\": 2,\n \"calibre_mm\": 0.065,\n \"calibre_amostra\": 30\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fields, per-subzone averages and calibrations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/pacientes/:paciente_id", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "pacientes", ":paciente_id" ], "query": [ { "key": "captura_id", "value": "", "disabled": true } ], "variable": [ { "key": "paciente_id", "value": "1" } ] }, "description": "" } }, { "name": "Use the averages in the plan", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/tricoscopia/usar-no-plano", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", "usar-no-plano" ] }, "description": "Fills the draft plan donors (density, hairs/FU, calibre, deviation, samples) and recalculates.", "body": { "mode": "raw", "raw": "{\n \"plano_id\": 318\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a field", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/tricoscopia/:id", "host": [ "{{base_url}}" ], "path": [ "tricoscopia", ":id" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "" } } ] }, { "name": "Validação médica", "item": [ { "name": "Validation queue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/validacoes", "host": [ "{{base_url}}" ], "path": [ "validacoes" ], "query": [ { "key": "tipo", "value": "", "disabled": true } ] }, "description": "Items awaiting a decision, up to 200, urgent ones first (triage, alarms, high-severity alerts) then the oldest: pending AI proposals (summaries excluded), responses awaiting validation, pre-assessments (lead-only ones just for callers who edit the clinical record), reported alerts awaiting validation and consultations awaiting signature (doctors see their own; with «all» scope, every one). Only patients in clinical scope; only the patient name and number. meta.contadores gives the count per type. Unknown type → every type. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Accept or refuse a reported alert", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/validacoes/alertas/:id/decisao", "host": [ "{{base_url}}" ], "path": [ "validacoes", "alertas", ":id", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "«aceite» validates the alert (stays active and counts in eligibility and the record header); «recusado» deactivates it. Records who decided and when. Effects: «aprovar» audit. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"aceite\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "AI performance review", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/validacoes/desempenho", "host": [ "{{base_url}}" ], "path": [ "validacoes", "desempenho" ], "query": [ { "key": "de", "value": "", "disabled": true }, { "key": "ate", "value": "", "disabled": true } ] }, "description": "Over a period (defaults to the last 90 days): agreement (accepted ÷ decided, in %), corrections and refusals, per proposal type and per model, and the weekly agreement trend. Only proposals for patients in the caller clinical scope. Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } }, { "name": "Validate or reject a response", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/validacoes/respostas/:id/decisao", "host": [ "{{base_url}}" ], "path": [ "validacoes", "respostas", ":id", "decisao" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only «por_validar» responses (otherwise 422). «validado» brings the response into the record and validates the alerts reported in it; «rejeitado» deactivates those alerts. Closes the linked medical review task. Effects: timeline (with patient), «aprovar» audit with the reason (up to 400 characters). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"decisao\": \"validado\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Return to the patient asking for information", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/validacoes/respostas/:id/devolver", "host": [ "{{base_url}}" ], "path": [ "validacoes", "respostas", ":id", "devolver" ], "variable": [ { "key": "id", "value": "1" } ] }, "description": "Only «por_validar» responses not saved by the team (otherwise 422). The response goes back to «pendente» with a new link (form settings deadline, 14 days by default); the request (1 to 2000 characters, encrypted) is shown at the top of the form, never in the message. Channel email, sms or whatsapp sends the service message without clinical content; «ligacao» only returns the link; any other value → email. expira_em comes in ISO 8601. Effects: «enviar» audit. Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After).", "body": { "mode": "raw", "raw": "{\n \"pedido\": \"Indique a dose e há quanto tempo toma o anticoagulante.\",\n \"canal\": \"email\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Queue item detail", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "en" } ], "url": { "raw": "{{base_url}}/validacoes/:tipo/:id", "host": [ "{{base_url}}" ], "path": [ "validacoes", ":tipo", ":id" ], "variable": [ { "key": "tipo", "value": "resposta" }, { "key": "id", "value": "1" } ] }, "description": "With the clinical content: the proposal (with pode_decidir), the readable response (items, score and band, alarm, photos, linked triage proposals), the alert or the consultation (with permissions). Type outside the list → 404. Lead-only items require «edit» on ficha.clinica. Read is audited («ver» on the item table). Patient out of scope: 403 «sem_permissao» with erro.paciente_id (the app offers emergency access). Limit (default): 120 requests per minute per access token (X-RateLimit-Limit/-Remaining/-Reset headers; beyond that 429 with Retry-After)." } } ] } ] }