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:Users: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.731Z

actionstringObrigatório

Identificador da action

Exemplo:@layers:data:Users: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 usuário deve estar ativo ou não

aliasstringObrigatório

Identificador único do usuário

namestringObrigatório

Nome do usuário

emailstringemailObrigatório

E-mail do usuário

birthstringdate

Data de nascimento do usuário

rolesSetobjectObrigatório

Define as permissões que devem ser editadas no usuário, é um objeto de chave-valor onde a chave é o identificador da permissão e o valor é um booleano indicando se a permissão deve ser adicionada ou removida, se não desejar alterar a permissão, basta não enviar a chave. As permissões padrões são (student, guardian, professor, coordenator, admin).

studentboolean

guardianboolean

professorboolean

coordenatorboolean

adminboolean

fieldsobject

Campos personalizados para o usuário, é 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.

updatedAtstringdate-timeObrigatório

Data da última atualiazção do usuário

cpfstring

CPF do usuário

addressobject

codestring

Código do endereço

statestring

Estado do endereço

citystring

Cidade do endereço

districtstring

Bairro do endereço

addressstring

Endereço

complementstring

Complemento do endereço

numberstring

Número do endereço