API - SEDUC Araruama - Sistema de Controle Escolar

Listar Todos os Alunos

Retorna uma lista paginada de todos os alunos cadastrados no sistema.

Parâmetros de Query

Exemplo de Requisição

GET /alunos?page=1&limit=50

Exemplo de Resposta

{
  "success": true,
  "pagination": {
    "total": 25430,
    "page": 1,
    "limit": 50,
    "totalPages": 509
  },
  "data": [
    {
      "id": 1,
      "nome": "João da Silva",
      "cpf": "123.456.789-00",
      "matricula": "2024001",
      "telefone": "(11) 98765-4321",
      "nomeEscola": "Escola Municipal Centro",
      "nomeTurma": "3º Ano A",
      "turno": "Manhã"
    }
  ]
}

Buscar Aluno por ID

Retorna os dados de um aluno específico.

Parâmetros de URL

Exemplo de Requisição

GET /alunos/id/123

Buscar Alunos por Escola

Retorna todos os alunos de uma escola específica.

Parâmetros

Exemplo de Requisição

GET /alunos/escola/ESC001?page=1&limit=50

Listar Todas as Escolas

Retorna uma lista de todas as escolas cadastradas no sistema.

Campos Retornados

• id - ID único da escola
• created_at - Data de cadastro
• escola_id - Código identificador da escola
• nomeescola - Nome completo da escola

Exemplo de Resposta

{
  "success": true,
  "pagination": {
    "total": 87,
    "page": 1,
    "limit": 50,
    "totalPages": 2
  },
  "data": [
    {
      "id": 1,
      "created_at": "2024-01-15T10:30:00-03:00",
      "escola_id": "ESC001",
      "nomeescola": "Escola Municipal Centro"
    }
  ]
}

Listar Todos os Dispositivos

Retorna uma lista paginada de todos os dispositivos cadastrados.

Campos Retornados

• id - ID único do dispositivo
• serial - Número de série do dispositivo
• sync_status - Status de sincronização (0=pendente, 1=sincronizado)
• last_connection - Data/hora da última conexão
• last_sync - Data/hora da última sincronização
• ip_address - Endereço IP do dispositivo
• is_online - Status online (true/false)
• last_check - Data/hora da última verificação

Exemplo de Resposta

{
  "success": true,
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 50,
    "totalPages": 3
  },
  "data": [
    {
      "id": 1,
      "serial": "REP001234",
      "sync_status": 1,
      "last_connection": "2024-12-16T14:30:00-03:00",
      "last_sync": "2024-12-16T14:25:00-03:00",
      "ip_address": "192.168.1.100",
      "is_online": true,
      "last_check": "2024-12-16T14:35:00-03:00"
    }
  ]
}

Listar Acessos

Retorna uma lista paginada de registros de acesso, ordenados por data/hora decrescente (mais recentes primeiro).

Campos Retornados

• id - ID único do registro
• created_at - Data de criação do registro (timezone São Paulo)
• dataEhora - Data e hora do acesso (timezone São Paulo)
• classeIDBubble - ID da classe
• classeNome - Nome da classe
• cnpjEscola - CNPJ da escola
• EscolaID - ID da escola
• horarioTexto - Descrição textual do horário
• matriculaID - Matrícula do aluno
• nomeAluno - Nome do aluno
• nomeEscola - Nome da escola
• nomeTurma - Nome da turma
• turmaIDbubble - ID da turma
• tipo - Tipo de acesso (entrada/saída)
• uuid - Identificador único universal
• dispositivo_nome - Nome do dispositivo
• dispositivo_id - ID do dispositivo

Importante: Timezone

Exemplo de Resposta

{
  "success": true,
  "pagination": {
    "total": 1250340,
    "page": 1,
    "limit": 50,
    "totalPages": 25007
  },
  "data": [
    {
      "id": 1250340,
      "created_at": "2024-12-16T15:30:00-03:00",
      "dataEhora": "2024-12-16T15:30:00-03:00",
      "classeIDBubble": "CLS001",
      "classeNome": "3º Ano",
      "cnpjEscola": "12.345.678/0001-90",
      "EscolaID": "ESC001",
      "horarioTexto": "Saída - Tarde",
      "matriculaID": "2024001",
      "nomeAluno": "João da Silva",
      "nomeEscola": "Escola Municipal Centro",
      "nomeTurma": "3º Ano A",
      "turmaIDbubble": "TRM001",
      "tipo": "saida",
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "dispositivo_nome": "Catraca Principal",
      "dispositivo_id": "DEV001"
    }
  ]
}