GILLIS INTERACTIVE
  1. Alunos
GILLIS INTERACTIVE
  • Comece aqui
  • Autenticação
    • Criar token
      POST
    • Validar token
      GET
    • Renovar token
      PUT
  • Alunos
    • Listar alunos
      GET
    • Listar aluno pelo ID
      GET
    • Cadastrar aluno
      POST
    • Atualizar aluno
      PUT
    • Deletar aluno
      DELETE
  • Cursos
    • Listar cursos
      GET
    • Curso matriculado
      GET
    • Matricular cursos
      POST
    • Remover cursos
      DELETE
  • Pacotes
    • Listar pacotes
      GET
    • Pacote matriculado
      GET
    • Matricular pacote
      POST
    • Remover pacote
      DELETE
  1. Alunos

Listar aluno pelo ID

GET
{{BaseURL}}/students/{{id}}

Descrição#

Endpoint para buscar um aluno específico pelo seu ID único. Retorna todos os dados completos do aluno, incluindo informações pessoais e do responsável.

📋 Detalhes da Requisição#

URL#

GET https://seudominio.com/api/students/{id}

Headers Obrigatórios#

Parâmetros de Rota#

CampoTipoObrigatórioDescrição
idint✅ SimID único do aluno (mínimo: 1)

📤 Respostas da API#

✅ Sucesso (200 OK)#

{
  "success": true,
  "message": "Aluno encontrado com sucesso",
  "data": {
    "id": 123,
    "nome": "João",
    "sobrenome": "Silva",
    "email": "joao@email.com",
    "usuario": "joao.silva",
    "ativo": "s",
    "deletado": "n",
    "telefone": "(11) 99999-9999",
    "cpf": "123.456.789-00",
    "data_nascimento": "1990-05-15",
    "endereco": "Rua das Flores, 123",
    "cidade": "São Paulo",
    "estado": "SP",
    "cep": "01234-567",
    "..." : "..."
  }
}

❌ Erro - Aluno Não Encontrado (404 Not Found)#

{
  "success": false,
  "message": "Aluno não encontrado",
  "error": "Not Found"
}

❌ Erro - ID Inválido (400 Bad Request)#

{
  "success": false,
  "message": "ID inválido",
  "error": "Bad Request"
}

❌ Erro - Token Inválido (401 Unauthorized)#

{
  "success": false,
  "message": "Unauthorized - Invalid or missing token",
  "error": "Unauthorized"
}

🔍 Campos Retornados#

Dados do Aluno#

CampoTipoDescrição
idintID único do aluno
nomestringNome do aluno
sobrenomestringSobrenome do aluno
tipostringTipo de usuário (geralmente "Presencial")
nascimentostringData de nascimento (YYYY-MM-DD)
anotacaostringAnotações sobre o aluno
usuariostringNome de usuário para login
emailstringEmail do aluno
cpfstringCPF do aluno
telefonestringTelefone do aluno
enderecostringEndereço completo
cidadestringCidade
estadostringEstado (UF)
paisstringPaís
dataCriadostringData de criação do registro
cepstringCEP
sexostringSexo (M/F)
rgstringRG do aluno

Dados do Responsável#

CampoTipoDescrição
nome_responsavelstringNome do responsável
sobrenome_responsavelstringSobrenome do responsável
rg_responsavelstringRG do responsável
cpf_responsavelstringCPF do responsável
sexo_responsavelstringSexo do responsável (M/F)
nascimento_responsavelstringData de nascimento do responsável
endereco_responsavelstringEndereço do responsável
cidade_responsavelstringCidade do responsável
estado_responsavelstringEstado do responsável
pais_responsavelstringPaís do responsável
cep_responsavelstringCEP do responsável
contato_responsavelstringTelefone do responsável
email_responsavelstringEmail do responsável

⚠️ Códigos de Status HTTP#

CódigoDescriçãoQuando Ocorre
200SuccessAluno encontrado com sucesso
400Bad RequestID inválido (menor que 1)
401UnauthorizedToken inválido ou não fornecido
404Not FoundAluno não encontrado
500Internal Server ErrorErro interno do servidor

🎯 Cenários de Uso#

1.
Perfil do Aluno - Exibir dados completos na página de perfil
2.
Edição de Dados - Carregar dados para formulário de edição
3.
Validação de Existência - Verificar se aluno existe antes de operações

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{BaseURL}}/students/{{id}}' \
--header 'Authorization: Bearer <token>'

Respostas

🟢200Correto
application/json
Body

Exemplo
{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "nome": "string",
        "sobrenome": "string",
        "tipo": "string",
        "nascimento": "string",
        "anotacao": "string",
        "usuario": "string",
        "email": "string",
        "cpf": "string",
        "telefone": "string",
        "endereco": "string",
        "cidade": "string",
        "estado": "string",
        "pais": "string",
        "dataCriado": "string",
        "cep": "string",
        "sexo": "string",
        "rg": "string",
        "nome_responsavel": "string",
        "sobrenome_responsavel": "string",
        "rg_responsavel": "string",
        "grupo": null,
        "cpf_responsavel": "string",
        "sexo_responsavel": "string",
        "nascimento_responsavel": "string",
        "endereco_responsavel": "string",
        "cidade_responsavel": "string",
        "estado_responsavel": "string",
        "pais_responsavel": "string",
        "cep_responsavel": "string",
        "contato_responsavel": "string",
        "email_responsavel": "string"
    },
    "timestamp": "string",
    "status_code": 0
}
Página anterior
Listar alunos
Próxima página
Cadastrar aluno
Built with