Módulo Escolas - POST - Associa vários alunos a uma escola

[nataliasou]

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/alunos
Body: { "alunos": [ { "id_aluno": 0 }, { "id_aluno": 1 }, { "id_aluno": 2 } ] }

Resultado do experimento: • Retorno do HTTP está 200 – OK (não era pra ser created?) • Não está documentado 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 • Há campos do tipo _links, deve ser feito assim mesmo?

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/aluns
Body: { "alunos": [ { "id_aluno": 0 }, { "id_aluno": 1 }, { "id_aluno": 2 } ] }

Resultado do experimento: • Retorno do HTTP está 404 – Not Found • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... }

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/0/alunos
Body: { "alunos": [ { "id_aluno": 0 }, { "id_aluno": 1 }, { "id_aluno": 2 } ] }

Resultado do experimento: • Retorno do HTTP está 404 – Not Found • Não está documentado na API • Escola não existe era para retornar erro e retornou em um formato estranho

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/0/52278827/aluns
Body: { "alunos": [ { "id_aluno": 0 }, { "id_aluno": 1 }, { "id_aluno": 2 } ] }

Resultado do experimento: • Retorno do HTTP está 403 - Forbidden • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... }

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/aluns
Body: {

}

Resultado do experimento: • Retorno do HTTP está 400 – Bad request • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... }

Exemplo de requisição: POST https://sete.transportesufg.eng.br/escolas/5201405/52278827/aluns
Body: { "data": [], "total": 0, "result": true }

Resultado do experimento: • Retorno do HTTP está 200 - OK • Não está documentado na API • Está usando o seguinte formato • { result: "false", “messages”: ... } • Verificar se era para ter retornado algum tipo de erro.

[nataliasou]

@umarley

post:
      tags:
      - escolas
      summary: Associa vários alunos a uma escola
      operationId: associarAlunoEscola
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade do aluno a ser atualizado
        required: true
      - in: path
        name: id_escola
        type: integer
        description: ID da escola que os alunos serão associados
        required: true
      - in: body
        name: body
        description: JSON contendo os id's dos alunos  que serão associados
        required: true
        schema:
          $ref: '#/definitions/VariosAlunos'
      responses:
        201:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/CreateResponseVariosAlunos'
        400:
          description: Parâmetros inválidos
        404:
          description: Recurso não encontrado
      security:
      - api_key: []

Response:

CreateResponseVariosAlunos:
    type: object
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            id_aluno:
              type: string
            result:
              type: boolean
            messages:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
      result:
        type: boolean

[umarley]

Documentação atualizada