Módulo escolas - GET - Obter todas as rotas associadas a uma escola

[nataliasou]

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/5201405/11020962/rotas Resultado: • Retorno do HTTP é 200 - Ok • Resultado é diferente da API • Está usando o seguinte formato { ..., total:0, result: true}

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/5201405/11020962/rota Resultado: • Retorno do HTTP é 200 - Ok • Resultado é diferente da API, retorna um erro dentro do 200, verificar se isso está correto. • Está usando o seguinte formato { ..., total:0, result: true}

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/5201405/0/rotas Resultado: • Retorno do HTTP é 404 – Not found • Não possui na documentação esse tipo de retorno. • Está usando o seguinte formato { ..., total:0, result: false} • Não retorna mensagem de erro

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/0/11020962/rotas Resultado: • Retorno do HTTP é 400 – Bad request • Não possui na documentação esse tipo de retorno. • Está usando o seguinte formato {result: false, “messages”: “string”}

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/111111111111111111/11020962/rotas Resultado: • Retorno do HTTP é 404 – Bad request • Não possui na documentação esse tipo de retorno. • Está usando o seguinte formato {result: false, “messages”: “string”}

[nataliasou]

@umarley

get:
      tags:
      - escolas
      summary: Obter todos as rotas associadas a uma escola
      operationId: getRotasEscola
      produces:
      - application/json
      parameters:
      - name: codigo_cidade
        in: path
        description: Código do municipio
        required: true
        type: integer
        format: int64
      - name: id_escola
        in: path
        description: ID da Escola que se deseja obter as rotas
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/allRotas'
        400:
          description: Parâmetros incorretos
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Models:

allRotas:
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/DadosRotas'
      total:
        type: integer
      result:
        type: boolean
  DadosRotas:
    properties:
      id_rota:
        type: integer
      id_escola:
        type: integer
      codigo_cidade:
        type: integer
      nome:
        type: string
      km:
        type: string
      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

[umarley]

API revisada e documentação atualizada.