Search docs/

Criar Grupo

{...}

Criar um novo grupo na Layers Education.

POST https://api.layers.digital/v1/group
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota.

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade

Requisição

Especificação

  • aliasString

    Identificador da turma único para a comunidade

  • nameStringobrigatório

    Nome do grupo

  • tagsObject[ ]

    tags às quais esse grupo pertence

  • adminsObject[ ]

    administradores do grupo

  • activeBoolean

    Chave que indica se o grupo está ativo (quando o grupo é apagado, essa chave é mudada para false)

  • fieldsObject

    Campos personalizados da comunidade. Podem ser diferentes de comunidade para comunidade dependendo do tipo de também dos apps instalados na comunidade.

Exemplo

{
  "alias": "3A",
  "name": "Terceiro ano A",
  "tags": [
    {
      "id": "exemplo",
      "name": "Ensino Fundamental"
    }
  ],
  "admins": [
    {
      "user": "exemplo"
    }
  ],
  "active": true,
  "fields": {
    "@education:basic": {
      "tipo": {
        "_id": "regular",
        "label": "Ensino Regular"
      },
      "nivel": {
        "_id": "EI:G0",
        "label": "Educação Infantil / Berçario"
      },
      "periodo": "manha"
    }
  }
}
CopiarCopiado

Resposta

Especificação

  • idString

    identificador do documento do grupo

  • aliasString

    Identificador da turma único para a comunidade

  • createdAtString

    Data de criação do grupo em UTC corrigido para o fuso da comunidade

  • updatedAtString

    Data da última modificação do grupo em UTC corrido para o fuso da comunidade

  • communityString

    Identificador da communidade do grupo

  • nameStringobrigatório

    Nome do grupo

  • tagsObject[ ]

    tags às quais esse grupo pertence

  • adminsObject[ ]

    administradores do grupo

  • activeBoolean

    Chave que indica se o grupo está ativo (quando o grupo é apagado, essa chave é mudada para false)

  • syncedAtString

    data da última vez que esse grupo foi modificado pela rota /sync

  • seasonString

    temporada à qual esse grupo pertence

  • fieldsObject

    Campos personalizados da comunidade. Podem ser diferentes de comunidade para comunidade dependendo do tipo de também dos apps instalados na comunidade.

Exemplo

{
  "id": "5bb2575199d7179dfe85be02",
  "alias": "3A",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "community": "test",
  "name": "Terceiro ano A",
  "tags": [
    {
      "id": "exemplo",
      "name": "Ensino Fundamental"
    }
  ],
  "admins": [
    {
      "user": "exemplo"
    }
  ],
  "active": true,
  "syncedAt": "2020-03-01T00:00:00.000Z",
  "season": "Ano letivo 2020",
  "fields": {
    "@education:basic": {
      "tipo": {
        "_id": "regular",
        "label": "Ensino Regular"
      },
      "nivel": {
        "_id": "EI:G0",
        "label": "Educação Infantil / Berçario"
      },
      "periodo": "manha"
    }
  }
}
CopiarCopiado