Áreas da pesquisa

Áreas são os grupos de perguntas de uma pesquisa. Elas são exibidas na ordem do campo sort_order. Corresponde à aba Áreas da tela Pesquisas de satisfação, do módulo Operacional.

A pesquisa é indicada pelo uuid no caminho. As áreas são identificadas pelo id numérico, e não por uuid.

Endpoints

Método	Caminho	Descrição
GET	/operational/surveys/{survey_uuid}/areas	Lista as áreas da pesquisa
POST	/operational/surveys/{survey_uuid}/areas	Cadastra uma área na pesquisa
GET	/operational/surveys/{survey_uuid}/areas/{id}	Consulta uma área
PUT	/operational/surveys/{survey_uuid}/areas/{id}	Altera uma área
DELETE	/operational/surveys/{survey_uuid}/areas/{id}	Apaga uma área

GET /operational/surveys/{survey_uuid}/areas

Lista as áreas de uma pesquisa.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
survey_uuid	Sim	uuid da pesquisa
column	Não	Coluna de ordenação, com o nome da tabela (por exemplo, surveys_areas.sort_order)
order	Não	Direção da ordenação: asc ou desc
per_page	Não	Quantidade de registros por página. Se omitido, a lista vem completa
page	Não	Número da página, quando per_page é informado

Resposta (200). Com per_page, a resposta é paginada. Sem per_page, é uma lista direta. Cada item traz id, survey_id, area, description, sort_order, survey_name, user_create_name e user_update_name.

curl -X GET "https://api.pedagogo.app/operational/surveys/<uuid-da-pesquisa>/areas?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /operational/surveys/{survey_uuid}/areas

Cadastra uma área na pesquisa. O servidor preenche o usuário que criou o registro.

Corpo

Campo	Obrigatório	Tipo	Descrição
area	Sim	Texto	Nome da área
description	Não	Texto	Descrição da área
sort_order	Não	Número inteiro	Posição da área na pesquisa. Se omitido, a área vai para o fim da lista

Resposta (200). A área criada, com o id gerado.

curl -X POST https://api.pedagogo.app/operational/surveys/<uuid-da-pesquisa>/areas \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"area": "Área exemplo", "description": "Descrição exemplo", "sort_order": 1}'

GET /operational/surveys/{survey_uuid}/areas/{id}

Consulta uma área. A resposta traz o objeto survey, com a pesquisa à qual a área pertence.

Resposta (200). A área, com o objeto survey.

PUT /operational/surveys/{survey_uuid}/areas/{id}

Altera uma área. Os campos não enviados mantêm o valor atual.

Corpo

Campo	Obrigatório	Tipo	Descrição
area	Não	Texto	Nome da área
description	Não	Texto	Descrição da área
sort_order	Não	Número inteiro	Posição da área na pesquisa

Resposta (200). A área após a alteração.

DELETE /operational/surveys/{survey_uuid}/areas/{id}

Apaga uma área. A exclusão é lógica.

Resposta (200): {"message": "Deleted successfully."}.