Módulo escolas - GET - Obter todos os alunos de uma escola

nataliasou commented 2 years ago

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

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

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/5201405/0/alunos Resultado: • Retorno do HTTP é 404 – Not found • Não está documentado na API • Está usando o seguinte formato { ..., total: 0, result: "false"} • Teria que retornar alguma mensagem de erro, verificar se é o correto com o Prof. Marcos e o Umarley

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/0/22046194/alunos Resultado: • Retorno do HTTP é 400 – Bad request • Não está documentado na API • Está usando o seguinte formato • { result: "false", messages: “string”}

Exemplo de requisição: GET https://sete.transportesufg.eng.br/escolas/111111111111111111/22046194/alunos Resultado: • Retorno do HTTP é 404 – Not found • Não está documentado na API • Está usando o seguinte formato { result: "false", messages: “string”}

nataliasou commented 2 years ago

@umarley

get:
      tags:
      - escolas
      summary: Obter todos os alunos de uma escola
      operationId: getAlunosEscola
      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
        required: true
        type: integer
        format: int64
      responses:
        200:
          description: successful operation
          schema:
            $ref: '#/definitions/allAlunos'
        400:
          description: Parâmetros incorretos
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Models:

allAlunos:
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/DadosAlunos'
      total:
        type: integer
      result:
        type: boolean

umarley commented 1 year ago

API revisada e documentação atualizada.

umarley / seteAPI

Módulo escolas - GET - Obter todos os alunos de uma escola #102