API Hub

Esta referência é de uma action do API Hub. Para mais informações, consulte a documentação do API Hub.

Esta é a referência da action @layers:data:Groups:getUpdatedAfter.
Para responder a esta action, seu app deve implementar uma rota que receba uma requisição POST seguindo os seguintes formatos de requisição e resposta:

Requisição

Este é o formato da requisição que sua API deve receber.

seasonstring

Identificador do período letivo

Exemplo:2020

afterstringdate-time

Quando especificado, deve filtrar entidades com o updatedAt maior ou igual ao after

Exemplo:2020-01-01T00:00:00.000Z

limitnumberinteger

Quando especificado, deve limitar o número de entidades retornadas para menor ou igual ao valor do limit

Exemplo:3

contextobjectObrigatório

Contexto da requisição

issuedAtstringdate-timeObrigatório

Data e hora de quando a requisição foi feita

Exemplo:2026-02-13T18:40:09.702Z

actionstringObrigatório

Identificador da action

Exemplo:@layers:data:Groups:getUpdatedAfter

communitystringObrigatório

Identificador da comunidade

Exemplo:idcomunidadeteste

secretstring

Chave secreta específica do app

Exemplo:********************

Resposta

Este é o formato da resposta que sua API deve retornar.

dataarrayObrigatório

items

activebooleanObrigatório

Indica se o grupo deve estar ativo ou não

aliasstringObrigatório

Identificador único do grupo

namestringObrigatório

Nome do grupo

fieldsobject

Campos personalizados para o grupo, é um objeto de chave-valor onde a chave é o identificador do campo e o valor é o valor do campo na estrutura em que foi definido previamente no manifesto do aplicativo.

@education:basicobject

Campo personalizado de educação básica

nivelstring

Identificador da turma

Exemplo:EM:S3

periodoarrayObrigatório

Lista de identificadores de períodos relacionados a esse componente

items

tipostringObrigatório

Tipo de ensino

Exemplo:regular

tagsarray

Lista de nomes de marcadores do grupo

items

componentsarray

Lista de identificadores únicos dos componentes do grupo

items

adminsarray

Lista de administradores do grupo. Todos os administradores que não estiverem na lista serão removidos do grupo. Os administradores podem ser identificados por alias ou e-mail

items

adminsSetarray

Lista de identificadores de administradores da turma a serem adicionados incrementalmente. Pode ser: alias ou email

items

usersarray

Lista de usuários da turma. Todos os usuários que não estiverem na lista serão removidos da turma. Os usuários devem ser identificados por alias

items

membersarrayObrigatório

Lista de membros da turma. Todos os membros que não estiverem na lista serão removidos da turma. Os membros devem ser identificados por alias

items

membersSetarray

Lista de identificadores de membros da turma a serem adicionados incrementalmente. Os membros devem são identificados por alias

items

seasonstringObrigatório

Período do grupo

Exemplo:2023

updatedAtstringdate-timeObrigatório

Data da última atualização do grupo