glcalil-ufg
commented
1 year ago @umarley
post:
tags:
- alunos
summary: Incluir um novo aluno no sistema
consumes:
- application/json
produces:
- application/json
parameters:
- in: path
name: codigo_cidade
description: Código da cidade na qual deseja cadastrar o aluno
type: integer
required: true
- in: body
name: body
description: Dados do aluno a ser cadastrado
required: true
schema:
$ref: '#/definitions/Aluno'
responses:
201:
description: Operação realizada com sucesso
schema:
$ref: '#/definitions/CreateResponse'
400:
description: Parâmetros inválidos
404:
description: Não encontrado
security:
- api_key: []Modelo Body
Aluno:
type: object
required:
- mec_tp_localizacao
- nome
- data_nascimento
- sexo
- cor
- nivel
- turno
properties:
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
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
xml:
name: AlunoModelo Response
CreateResponse:
type: object
properties:
result:
type: boolean
messages:
type: array
items:
type: object
properties:
id:
type: string
description: ID do objeto criado
Módulo Aluno
Exemplo de requisição:
POST https://sete.transportesufg.eng.br/aluno/5201405
Path:
codigo_cidade: 5201405
Body:
Resultado do experimento:
Retorno do HTTP está 201 (CREATED)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "true", messages: {“id”: <id_aluno>} }
Exemplo de requisição:
POST https://sete.transportesufg.eng.br/aluno/52014059999
1 - Campo cidade errado;
2 - Campos obrigatórios faltando;
Resultado do experimento:
Retorno do HTTP está 403 (FORBIDDEN) e 400 (BAD REQUEST)
O resultado está diferente do esperado na API
Está usando o seguinte formato
{ result: "false", messages : “...” }