umarley / seteAPI

BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Módulo Motoristas - GET - Obter as rotas associadas ao motorista #122

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/5201405/16709683320/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

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/520140599/16709683320/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/motoristas/5201405/1670968332099/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" }



glcalil-ufg commented 2 years ago

@umarley

get:
      tags:
      - motoristas
      summary: Obter as rotas associadas ao motorista
      description: Retornar a lista de rotas associadas ao cadastro do motorista
      operationId: getRotaMotorista
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade do aluno a ser atualizado
        required: true
      - name: cpf_motorista
        in: path
        description: CPF do motorista que se deseja consultar as rotas vinculadas
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação Realizada com Sucesso
          schema:
            $ref: '#/definitions/RotasMotorista'
        400:
          description: Parametros incorretos
        404:
          description: Rotas não encontradas
      security:
      - api_key: []

Modelo

RotasMotorista:
    type: object
    properties:
      data:
        type: array
        xml:
          wrapped: true
        items:
          $ref: '#/definitions/MotoristaRota'
      total:
        type: integer
      result:
        type: boolean

  MotoristaRota:
    type: object
    properties:
      id_rota:
        type: integer
      cpf:
        type: string
      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

API revisada e documentação atualizada