Módulo Alunos - GET - Obter dados da rota associada ao aluno

glcalil-ufg commented 2 years ago

Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405/9/rota
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
Campo shape abreviado neste documento para melhor leitura da response
Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405999/9/rota
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 : “...” }

Exemplo de requisição:
GET https://sete.transportesufg.eng.br/alunos/5201405/263189/rota
Resultado do experimento:
Retorno do HTTP está 404 (NOT FOUND)
O resultado está diferente do esperado na API
Mesma resposta para alunos sem rota cadastrada ou <id_aluno> incorreto
Está usando o seguinte formato
Erro não capturado, { result: "false" }

glcalil-ufg commented 2 years ago

@umarley

get:
      tags:
      - alunos
      summary: Obter os dados da rota associada ao aluno
      description: Retornar a rota associada ao cadastro do aluno
      operationId: getRotaAluno
      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 que se deseja consultar a rota vinculada
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/RotaAluno'
        400:
          description: Dados inválidos
        404:
          description: Rota não encontrada

Modelo

RotaAluno:
    type: object
    properties:
      id_aluno:
        type: integer
      id_rota:
        type: integer
      codigo_cidade:
        type: integer
      nome:
        type: string
      km:
        description: Tamanho da rota (em km)
        type: number
      hora_ida_inicio:
        description: Horário de inicio da Ida no formato hh:mm
        type: string
      hora_ida_termino:
        description: Horário de inicio da Volta no formato hh:mm
        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
      turno_matutino:
        type: string
        description: Funciona no turno da manhã? S = Sim N = Não
        enum:
        - S
        - N
      turno_vespertino:
        type: string
        description: Funciona no turno da tarde? S = Sim N = Não
        enum:
        - S
        - N
      turno_noturno:
        type: string
        description: Funciona no turno da noite? S = Sim N = Não
        enum:
        - S
        - N
      shape:
        description: JSON do traçado da rota de forma vetorial
        type: string
      hora_volta_inicio:
        description: Horário de inicio da Volta no formato hh:mm
        type: string
      hora_volta_termino:
        description:  Horário de término da Volta no formato hh:mm
        type: string
      tempo:
        description: Tempo da rota (em minutos)
        type: integer
      tipo:
        type: integer
        description: Tipo da rota 1. Rodoviária 2. Aquaviaria 3. Mista
        enum:
        - 1
        - 2
        - 3
      id_firebase: 
        type: integer

umarley commented 1 year ago

RotasAluno:
    type: object
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/ListaIDRotas'
  ListaIDRotas:
    type: object
    properties:
      id_rota:
        type: integer

API revisada e documentação atualizada

umarley / seteAPI

Módulo Alunos - GET - Obter dados da rota associada ao aluno #119