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": "2023-12-01T15:32:29.463Z",
    "action": "@layers:identificador_da_action",
    "community": "idcomunidadeteste"
  },
  "secret": "exemplo1-e000-11xe-2m33-4444444plo",
  "data": {
    "syncProfileId": "5bb2575199d7179dfe85be02",
    "syncRunId": "5bb2575199d7179dfe85be02",
    "season": "2021",
    "after": "2023-12-01T15:32:29.463Z",
    "limit": 100
  }
}
CopiarCopiado

Resposta

Especificação

  • dataLayersDataGroupsResponseDatum[ ]obrigatório

  • removeUnlistedTagsBooleanobrigatório

    Indica se os marcadores não listados nos grupos devem ser desvinculados

  • removeUnlistedAdminsBooleanobrigatório

    Indica se os administradores não listados nos grupos devem ser desvinculados

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@startwars.com",
          "components": [
            "exemplo"
          ]
        },
        {
          "alias": "exemplo",
          "components": [
            "exemplo"
          ]
        }
      ],
      "enrollments": {
        "users": [
          "exemplo"
        ],
        "members": [
          "exemplo"
        ]
      },
      "members": [
        "1234"
      ],
      "season": "exemplo",
      "updatedAt": "2023-12-01T15:32:29.463Z"
    }
  ],
  "removeUnlistedTags": true,
  "removeUnlistedAdmins": true
}
CopiarCopiado