O serviço retorna o PDF com os devidos metadados adicionados. Os PDFs retornados devem ser salvos para serem assinados digitalmente com o certificado digital do médico.
Sucesso
Requisições que ocorrem com sucesso retornam código HTTP 200. Para mais detalhes com os dados, acesse a tabela:
Configuração um documento:
O retorno é o stream (byte array) do PDF:
pdf_stream
Configuração de lote:
O retorno é um array dos documentos PDFs codificados em Base64:
Operação executada com sucesso: o(s) PDF(s) com os devidos metadados adicionados.
Erro
Requisições que ocorrem com erro retornam código HTTP 4xx ou 5xx. Para mais detalhes com os dados, acesse a tabela:
O modelo da resposta JSON é mostrado abaixo:
{
"status": http status,
"message": "mensagem de erro",
"chave": "chave referente a mensagem de erro",
"timestamp": "timestamp em que ocorreu o erro"
}
Retorno de erro de requisição
Código
Descrição
400
Bad Request (Requisição mal-formada)
As possíveis mensagem de erro e chaves de erro, estão listadas na tabela abaixo:
Chave
Descrição
excecao.hub.requisicao
Não foi possível concluir o processamento da requisição com sucesso.
excecao.hub.recurso.inexistente
Recurso requisitado não existe. Recurso requisitado: {0}
excecao.hub.requisicao.param.nulo
Parâmetro {0} da requisição não pode ser nulo.
excecao.hub.prescricao.profissional
É necessário informar o tipo de profissional. [Valores disponíveis: MEDICO ou FARMACEUTICO]
excecao.hub.prescricao.profissional.invalido
O tipo de profissional informado é inválido. [Valores disponíveis: MEDICO ou FARMACEUTICO].
excecao.hub.prescricao.uf
É necessário informar a UF (Unidade Federativa) do profissional.
excecao.hub.prescricao.tipo.nula
É necessário informar o tipo de prescrição {0} do documento. [Valores disponíveis: MEDICAMENTO, ATESTADO, SOLICITACAO_EXAME, LAUDO, SUMARIA_ALTA, ATENDIMENTO_CLINICO, DISPENSACAO_MEDICAMENTO, VACINACAO e RELATORIO_MEDICO].
excecao.hub.prescricao.tipo.invalida
O tipo de prescrição informado em {0} não é válido. [Valores disponíveis: MEDICAMENTO, ATESTADO, SOLICITACAO_EXAME, LAUDO, SUMARIA_ALTA, ATENDIMENTO_CLINICO, DISPENSACAO_MEDICAMENTO, VACINACAO e RELATORIO_MEDICO].
excecao.hub.prescricao.especialidade.nula
É necessário informar a especialidade do profissional.
excecao.hub.prescricao.registro
É necessário informar o número de registro do profissional.
excecao.hub.token.corrompido
Não foi possível decodificar o token JWT enviado em 'Authorization'.
