Search docs/

Enviar dados de sincronização

{...}

Enviar entidades para sincronização com a Layers.

POST https://api.layers.digital/v2/sync/{syncRunId}/uploadEntities
CopiarCopiado

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • syncRunId
    (path)
    obrigatório
    Identificador da rodada de sincronização

Requisição

Especificação

Exemplo

{
  "groups": {
    "data": [
      {
        "alias": "turma-1a",
        "name": "1ª Série A",
        "members": [
          "aluno-1",
          "aluno-2"
        ],
        "membersSet": [
          "aluno-1",
          "aluno-2"
        ],
        "adminsSet": [
          "admin-1",
          "admin-2"
        ],
        "admins": [
          {
            "email": "admin@escola.com",
            "alias": "admin-1",
            "components": [
              "matematica-ensino-medio",
              "portugues-ensino-medio"
            ]
          }
        ],
        "components": [
          "matematica-ensino-medio",
          "portugues-ensino-medio"
        ],
        "tags": [
          "ensino-medio",
          "integral"
        ],
        "fields": {
          "@education:basic": {
            "tipo": "regular",
            "nivel": "EM:S1",
            "periodo": [
              "manha",
              "tarde"
            ]
          }
        },
        "season": "2025-1",
        "active": true
      }
    ],
    "removeUnlistedAdmins": true,
    "removeUnlistedComponents": true,
    "removeUnlistedEnrollments": true,
    "removeUnlistedTags": true
  },
  "members": {
    "data": [
      {
        "active": true,
        "users": [
          "aluno1@escola.com",
          "aluno1-alias"
        ],
        "alias": "aluno1-alias",
        "birth": "2010-05-22",
        "name": "João da Silva"
      }
    ],
    "removeUnlistedUsers": true
  },
  "users": {
    "data": [
      {
        "active": true,
        "alias": "usuario123",
        "name": "Maria Oliveira",
        "email": "maria.oliveira@escola.com",
        "birth": "1990-08-15",
        "rolesSet": {
          "student": true,
          "guardian": true,
          "professor": true,
          "coordenator": true,
          "admin": true
        }
      }
    ]
  },
  "components": {
    "data": [
      {
        "active": true,
        "alias": "matematica-ensino-medio",
        "name": "Matemática",
        "fields": {
          "@education:basic": {
            "inep": "3"
          }
        }
      }
    ]
  }
}
CopiarCopiado