Listar matriculas
{...}Listar matriculas do grupo especificado
GET https://api.layers.digital/v1/groups/{groupId}/enrollments
CopiarCopiado
Autenticação
Autenticação do tipo
Token Bearer é necessária para acessar essa rota.
Parâmetros
- community-id(header)obrigatórioIdentificador da comunidade
- groupId(path)obrigatórioIdentificador do grupo.
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
[].kindString
Tipo de entidade que está vinculada ao grupo
[].entity
[].groupString
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": {
"id": "12345678",
"createdAt": "2020-01-01T00:00:00.000Z",
"updatedAt": "2020-01-01T00:00:00.000Z",
"active": true,
"community": "test",
"access": [
{
"permissions": [
"guardian"
],
"user": "exemplo"
}
],
"name": "Gabriel Raniere",
"alias": "abc123d",
"birth": "2010-04-10T00:00:00.000Z"
},
"group": "5bb2575199d7179dfe85be02",
"active": true
}
]
CopiarCopiado