Nunciatura Provista

API Documentation V1

Compartilhar questionário

Compartilha o questionário com um colaborador externo (apenas G1Q1 e G1Q2)

Endpoint Protected

Descrição

Envia um convite por email para um colaborador externo preencher o questionário. Apenas questionários compartilháveis (Indicação de informadores e Perfil da Diocese). O questionário Terna de candidatos (G1Q3) não pode ser compartilhado. O informador não precisa iniciar o questionário antes: quem receber o email pode abrir o link e ser o primeiro a preencher. Se já houver um colaborador, ele é substituído. O colaborador pode editar e salvar rascunho, mas não pode finalizar.

Opção 1 – Sem resposta ainda (quem recebe o email pode iniciar)

Use quando o questionário estiver "Não Iniciado". O backend cria a resposta em rascunho e envia o link; o colaborador pode abrir e começar a preencher.

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provisao.hmg.nabrasil.org.br/v1

ENDPOINT

/questionnaires/{questionnaire}/share 
{
  "email": "colaborador@exemplo.com",
  "process_id": "uuid",
  "group_id": "uuid"
}

Resposta 200 inclui answer_id (para usar em revogar/substituir), shared_with e shared_waiting_first_access.

Opção 2 – Com resposta já existente

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provisao.hmg.nabrasil.org.br/v1

ENDPOINT

/questionnaires/{questionnaire}/answers/{answer}/share 
{
  "email": "colaborador@exemplo.com"
}

Resposta 200

{
  "success": true,
  "message": "Questionário compartilhado com sucesso...",
  "data": {
    "shared_with": "colaborador@exemplo.com",
    "shared_waiting_first_access": true
  }
}

403 quando o questionário não pode ser compartilhado (ex.: G1Q3) ou a resposta já está finalizada.

Códigos de Resposta

Código Descrição
200 Compartilhado; email enviado
403 Questionário não compartilhável ou já finalizado
422 Email inválido