Módulo Rotas - GET - Obter todas as escolas associadas a rota

[glcalil-ufg]

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73430/escolas

Resultado do experimento:

• Retorno do HTTP está 200 (OK)

• O resultado está diferente do esperado na API

• Está usando o seguinte formato 

{ ..., total: <valor>, result: "true" }

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73170/escolas

Resultado do experimento:

• Retorno do HTTP está 404 (NOT FOUND)

• O resultado está diferente do esperado na API

• Resultado encontrado para rotas não existentes ou sem escolas

• Está usando o seguinte formato 

{ ..., total: <valor>, result: "false" }

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/52014099995/73170/escolas

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 : “...” }

[glcalil-ufg]

@umarley

 get:
      tags:
      - rotas
      summary: Obter todas as escolas associadas a rota
      description: Retornar os dados das escolas associadas ao cadastro da rota
      operationId: getEscolasRota
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade da rota que se deseja consultar
        required: true
      - name: id_rota
        in: path
        description: ID da rota que se deseja obter as escolas vinculadas
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/RotaEscolas'
        400:
          description: Parâmetros inválidos
        404:
          description: Escolas não encontradas
      security:
      - api_key: []

Modelo

RotaEscolas:
    type: object
    properties:
      data: 
        type: array
        items:
          type: object
          properties:
            id_rota: 
              type: integer
            id_escola:
              type: integer
            codigo_cidade:
              type: integer
            nome:
              type: string
            loc_latitude:
              type: string
            loc_longitude: 
              type: string
            horario_matutino:
              type: string
            horario_vespertino:
              type: string
            horario_noturno:
              type: string
            ensino_medio:
              type: string
            ensino_fundamental:
              type: string
            ensino_superior:
              type: string
            ensino_pre_escola:
              type: string
            mec_tp_localizacao:
              type: integer
      total:
        type: integer
      result:
        type: boolean

[umarley]

API revisada e documentação atualizada