Search docs/

Usuários atualizados

{...}

Prover os usuários 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:Users:getUpdatedAfter
CopiarCopiado

Requisição

Especificação

  • contextObjectobrigatório

  • secretStringobrigatório

    Chave secreta específica do app

  • dataObject

Exemplo

{
  "context": {
    "issuedAt": "2024-10-15T14:44:53.190Z",
    "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": "123",
      "name": "João",
      "email": "joao@layers.education",
      "rolesSet": {
        "student": false,
        "guardian": true,
        "professor": false,
        "coordenator": false
      },
      "fields": {
        "field1": "value1",
        "field2": "value2"
      },
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    {
      "active": true,
      "alias": "456",
      "name": "Maria",
      "email": "maria@layers.education",
      "rolesSet": {
        "student": false,
        "guardian": true,
        "professor": true,
        "coordenator": false,
        "admin": true
      },
      "fields": {
        "field1": "value1",
        "field2": "value2"
      },
      "updatedAt": "2020-02-01T00:00:00.000Z"
    },
    {
      "active": false,
      "alias": "789",
      "name": "Fulano",
      "email": "fulano@layers.education",
      "rolesSet": {
        "student": true,
        "guardian": false,
        "professor": false,
        "coordenator": false
      },
      "fields": {
        "field1": "value1",
        "field2": "value2"
      },
      "updatedAt": "2020-03-01T00:00:00.000Z"
    }
  ]
}
CopiarCopiado