Saltar para o conteúdo principal
POST
Envia ao cliente um email a informar que os resultados laboratoriais estão prontos. O email é enviado para o email do perfil da marcação. O e-mail usa a marca genérica do parceiro: o nome e o logótipo do grupo de perfis principal do perfil. Está no language do perfil, inglês por predefinição. Define with_reports como true para anexar os relatórios laboratoriais da marcação. O email anexa todos os relatórios que o cliente pode ver na app. Define-o como false para enviar apenas o aviso. Adiciona note para mostrar uma nota pessoal no email, com um máximo de 1 000 caracteres. Cada relatório anexado é um PDF encriptado com AES-256. A palavra-passe é a date_of_birth do perfil em 8 dígitos, DDMMYYYY, sem pontos: um cliente nascido a 1 de fevereiro de 1985 escreve 01021985. O email indica este formato ao cliente, mas nunca a data de nascimento em si. Cada chamada envia um email. As chamadas não são deduplicadas: se chamares o endpoint duas vezes, o cliente recebe dois emails. O email não é enviado quando:
  • Ainda não chegou nenhum relatório laboratorial.
  • O perfil não tem endereço de email, ou tem apenas um endereço provisório @aniva.email.
  • O perfil desativou os emails transacionais. Para os voltar a ativar, define transactional_emails_enabled como true com Atualizar perfil.
  • with_reports é true e o perfil não tem date_of_birth. Define-a com Atualizar perfil, ou envia com with_reports: false.
Requer o scope results_view.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da marcação cujos resultados queres enviar por email.

Parâmetros do corpo

boolean
obrigatório
true anexa os relatórios laboratoriais como ficheiros PDF protegidos por palavra-passe. false envia apenas o aviso de que os resultados estão prontos.
string
Uma nota pessoal que o email mostra abaixo do aviso. No máximo 1 000 caracteres.

Resposta

Em caso de sucesso, a API devolve 200 OK.
string
obrigatório
O endereço para onde o email foi enviado: o email do perfil.
integer
obrigatório
O número de relatórios laboratoriais anexados. 0 quando with_reports é false.
string
obrigatório
Quando o email foi enviado, como um instante UTC (ISO 8601 com sufixo Z).

Respostas de erro

Um corpo de erro tem error, uma mensagem legível por humanos, e reason, um código estável. Os erros de validação e a falta do scope results_view não têm reason.