EDeduzz
Alpaclass

Listar alunos da escola

Changed on
get/alpaclass/v1/producer/teams/:teamId/students

Request

Path parameters

teamIdstring required

Id da escola

Example:aBc123

Query parameters

pagenumber

Página atual

itemsPerPagenumber

Número máximo de itens por página

sortstring

Ordenação dos itens podendo ter várias ordenações, seguindo o seguinte padrão: campo:ordenação Ex.: name:asc,email:desc

idstring

Id do aluno

emailstring

E-mail do aluno

documentstring

Documento do aluno

startDatestring date-time

Data de início do cadastro dos alunos

endDatestring date-time

Data de fim do cadastro dos alunos

isFrozenboolean

Status de congelamento do aluno

Response

Listar alunos da escola

pagesnumber required

Número de páginas

pagenumber required

Página atual

itemsPerPagenumber required

Número máximo de itens por página

totalItemsnumber required

Número total de items

Example response

{
  "items": [
    {
      "id": "xPt123",
      "name": "João Carlos",
      "email": "test@test.com",
      "createdAt": "2023-01-01T00:00:00Z"
    }
  ]
}

Changes

  • f93320e6a417Revision changes
    • info

      the query request parameter document became optional

    • info

      the query request parameter email became optional

    • info

      the query request parameter endDate became optional

    • info

      the query request parameter id became optional

    • info

      the query request parameter isFrozen became optional

    • info

      the query request parameter itemsPerPage became optional

    • info

      the query request parameter page became optional

    • info

      the query request parameter sort became optional

    • info

      the query request parameter startDate became optional

  • 8e41c62b53a8Revision changes
    • breaking

      the query request parameter document became required

    • breaking

      the query request parameter email became required

    • breaking

      the query request parameter endDate became required

    • breaking

      the query request parameter id became required

    • breaking

      the query request parameter isFrozen became required

    • breaking

      the query request parameter itemsPerPage became required

    • breaking

      the query request parameter page became required

    • breaking

      the query request parameter sort became required

    • breaking

      the query request parameter startDate became required

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter endDate

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ to the query request parameter startDate

    • breaking

      for the query request parameter endDate, the format changed from no format to date-time

    • breaking

      for the query request parameter isFrozen, the type changed from string to boolean

    • breaking

      for the query request parameter itemsPerPage, the type changed from string to number

    • breaking

      for the query request parameter page, the type changed from string to number

    • breaking

      for the query request parameter startDate, the format changed from no format to date-time