Search docs/

Atualizar matricula

{...}

Atualizar matrícula especificada

PUT https://api.layers.digital/v1/enrollments/{enrollmentId}
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
  • enrollmentId
    (path)
    obrigatório
    Identificador da matrícula
  • group
    (query)
    Identificador do grupo

Requisição

Especificação

  • kindStringobrigatório

    Tipo de entidade que está vinculada ao grupo

  • entityStringobrigatório

    Identificador do documento da entidade à qual pertence essa matrícula

  • groupStringobrigatório

    Identificador do grupo à qual a entidade está matriculada

  • activeBoolean

    Chave que indica se essa matrícula está ativa (é mudada para false quando a entidade é removida do grupo)

Exemplo

{
  "kind": "member",
  "entity": "5bb2575199d7179dfe85be02",
  "group": "5bb2575199d7179dfe85be02",
  "active": true
}
CopiarCopiado

Resposta

Especificação

  • idString

    Identificador do documento da matrícula

  • createdAtString

    Data de criação da matrícula em UTC corrigido para o fuso da comunidade

  • updatedAtString

    Data da última modificação da matrícula em UTC corrido para o fuso da comunidade

  • communityString

    Identificador da comunidade da matrícula

  • kindStringobrigatório

    Tipo de entidade que está vinculada ao grupo

  • entityStringobrigatório

    Identificador do documento da entidade à qual pertence essa matrícula

  • groupStringobrigatório

    Identificador do grupo à qual a entidade está matriculada

  • activeBoolean

    Chave que indica se essa matrícula está ativa (é mudada para false quando a entidade é removida do grupo)

Exemplo

{
  "id": "5bb2575199d7179dfe85be02",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "updatedAt": "2020-01-01T00:00:00.000Z",
  "community": "test",
  "kind": "member",
  "entity": "5bb2575199d7179dfe85be02",
  "group": "5bb2575199d7179dfe85be02",
  "active": true
}
CopiarCopiado