Search docs/

Grupos atualizados

{...}

Prover os grupos da comunidade de acordo com o período letivo que foram atualizados a partir de uma data específica.

POST https://api.layers.digital/v1/@layers:data:Groups:getUpdatedAfter
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2024-02-21T19:54:50.942Z",
    "action": "@layers:identificador_da_action",
    "community": "idcomunidadeteste"
  },
  "secret": "exemplo1-e000-11xe-2m33-4444444plo",
  "data": {
    "syncProfileId": "5bb2575199d7179dfe85be02",
    "syncRunId": "5bb2575199d7179dfe85be02",
    "season": "2020",
    "after": "2020-01-01T00:00:00.000Z",
    "limit": 3
  }
}
CopiarCopiado

Resposta

Especificação

  • dataObject[ ]obrigatório

Exemplo

{
  "data": [
    {
      "active": true,
      "alias": "exemplo",
      "name": "exemplo",
      "fields": {
        "@education:basic": {
          "nivel": "EM:S3",
          "periodo": [
            [
              "manha",
              "tarde"
            ]
          ],
          "tipo": "regular"
        }
      },
      "tags": [
        "exemplo"
      ],
      "components": [
        "exemplo"
      ],
      "admins": [
        {
          "email": "luke@starwars.com",
          "components": [
            "exemplo"
          ]
        },
        {
          "alias": "exemplo",
          "components": [
            "exemplo"
          ]
        }
      ],
      "adminsSet": [
        "123abc",
        "admin.de.turma@layers.digital"
      ],
      "members": [
        "1234"
      ],
      "membersSet": [
        "123abc",
        "456def"
      ],
      "season": "2023",
      "updatedAt": "2024-02-21T19:54:50.942Z"
    }
  ]
}
CopiarCopiado