glcalil-ufg
commented
2 years ago @umarley
get:
tags:
- alunos
summary: Obter os dados de um aluno especifico
description: Returns a single pet
operationId: getPetById
produces:
- application/json
parameters:
- in: path
name: codigo_cidade
type: integer
description: Código da cidade do aluno a ser atualizado
required: true
- name: id_aluno
in: path
description: Id do aluno buscado
required: true
type: integer
format: int64
responses:
200:
description: Operação realizada com sucesso
schema:
$ref: '#/definitions/AlunoRetorno'
400:
description: Parametros incorretos
404:
description: Aluno não encontrado
security:
- api_key: []Modelo
AlunoRetorno:
type: object
required:
#- mec_tp_localizacao
#- nome
#- data_nascimento
#- sexo
#- cor
#- nivel
#- turno
properties:
codigo_cidade:
type: integer
id_aluno:
type: integer
loc_latitude:
type: string
loc_longitude:
type: string
loc_endereco:
type: string
loc_cep:
type: string
da_porteira:
type: string
description: Tem porteira? S = Sim N = Não
enum:
- S
- N
da_mataburro:
type: string
description: Tem mata-burro? S = Sim N = Não
enum:
- S
- N
da_colchete:
type: string
description: Tem colchete? S = Sim N = Não
enum:
- S
- N
da_atoleiro:
type: string
description: Tem atoleiro? S = Sim N = Não
enum:
- S
- N
da_ponterustica:
type: string
description: Tem ponte rústica? S = Sim N = Não
enum:
- S
- N
nome:
type: string
data_nascimento:
description: Data de nascimento no formato dd/mm/yyyy
type: string
sexo:
type: integer
description: Sexo do Aluno 1. Masculino 2. Feminino 3. Não Informado
enum:
- 1
- 2
- 3
cor:
type: integer
description: Cor/raça do Aluno 0. Não informada 1. Amarelo 2. Branco 3. Indigena 4. Pardo 5. Preto
enum:
- 0
- 1
- 2
- 3
- 4
- 5
turno:
type: integer
description: Turno de estudo do Aluno 1. Matutino 2. Vespertino 3. Integral 4. Noturno
enum:
- 1
- 2
- 3
- 4
nivel:
type: integer
description: Nível do Aluno 1. Infantil 2. Fundamental 3. Médio 4. Superior 5. Outro
enum:
- 1
- 2
- 3
- 4
- 5
nome_responsavel:
type: string
grau_responsavel:
type: integer
description: Grau de parentesco -1; Não informado 0. Pai, Mãe, Padrasto ou Madrasta 1. Avô ou Avó 2. Irmão ou Irmã 4. Outro Parente
enum:
- 0
- 1
- 2
- 4
telefone_responsavel:
type: string
mec_tp_localizacao:
type: integer
description: Localização do Aluno 1. Urbana 2. Rural
enum:
- 1
- 2
cpf:
type: string
def_caminhar:
type: string
description: Tem deficiência fisica? S = Sim N = Não
enum:
- S
- N
def_ouvir:
type: string
description: Tem deficiência auditiva? S = Sim N = Não
enum:
- S
- N
def_enxergar:
type: string
description: Tem deficiência visual? S = Sim N = Não
enum:
- S
- N
def_mental:
type: string
description: Tem deficiência mental? S = Sim N = Não
enum:
- S
- N
codigo_aluno_firebase:
type: string
mec_id_proprio:
type: string
mec_id_inep:
type: string
dt_criacacao:
type: string
criado_por:
type: string
dt_alteracao:
type: string
alterado_por:
type: string
id_escola:
type: integer
xml:
name: Aluno
umarley
Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405/1
Resultado do experimento:
Retorno do HTTP está 200 (OK)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ ..., result: "true" }
Há vários campos NULL, verificar se é o correto com o Prof. Marcos e o Umarley
Há campos do tipo _links, deve ser feito assim mesmo?
Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405/999999
Resultado do experimento:
Retorno do HTTP está 404 (NOT FOUND)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ ..., result: "false" }
Há campos do tipo _links, deve ser feito assim mesmo?
Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405999/1
Resultado do experimento:
Retorno do HTTP está 404 (NOT FOUND)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "false", messages : “...” }