Módulo escolas- GET - Listar escolas de um município

[nataliasou]

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/5201405 Resultado: • Retorno do HTTP está 200 (OK) • O resultado está diferente do esperado na API • Está usando o seguinte formato { ..., “total”: 0, result: "true" } • Tem links, verificar se é o correto com o Prof. Marcos e o Umarley

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/0 Resultado: • Retorno do HTTP está 400 – Bad request • A documentação não possui esse retorno. • Está usando o seguinte formato { result: "false", “messages”: “string” } • Talvez não seja o retorno certo

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/1111111111111 Resultado: • Retorno do HTTP está 404 - Not found • A documentação não possui esse retorno. • Está usando o seguinte formato • { result: "false", “messages”: “string” }

[nataliasou]

@umarley

get:
      tags:
      - escolas
      summary: Listar escolas de um municipio
      description: Retorna registro de escolas cadastradas no municipio
      produces:
      - application/json
      parameters:
      - name: codigo_cidade
        in: path
        description: Código do municipio 
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso.
          schema:
            $ref: '#/definitions/allEscolas'
        400:
          description: Parâmetros incorretos
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Models:

allEscolas:
    type: object
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/DadosEscolas'
      total:
        type: integer
      result:
        type: boolean
  DadosEscolas:
    type: object
    properties:
      codigo_cidade:
        type: string
      id_escola:
        type: integer
      loc_latitude:
        type: string
      loc_longitude:
        type: string
      horario_matutino:
        type: string
        description: Escola funciona no horário matutino? S = Sim N = Não
        enum:
        - S
        - N
      horario_vespertino:
        type: string
        description: Escola funciona no horário vespertino? S = Sim N = Não
        enum:
        - S
        - N
      horario_noturno:
        type: string
        description: Escola funciona no horário noturno? S = Sim N = Não
        enum:
        - S
        - N
      ensino_medio:
        type: string
        description: Escola oferece ensino médio? S = Sim N = Não
        enum:
        - S
        - N
      ensino_fundamental:
        type: string
        description: Escola oferece ensino fundamental? S = Sim N = Não
        enum:
        - S
        - N
      ensino_superior:
        type: string
        description: Escola oferece ensino superior? S = Sim N = Não
        enum:
        - S
        - N
      ensino_pre_escola:
        type: string
        description: Escola oferece ensino pré-escola? S = Sim N = Não
        enum:
        - S
        - N
      mec_tp_localizacao:
        type: integer
        description: Localização da escola 1. Urbana 2. Rural
        enum:
        - 1
        - 2
        - 4
      qtd_alunos:
        type: integer

[umarley]

API revisada e documentação atualizada.