API: Gerenciamento de times pelos endpoints de USERS e TEAMS
Atualizado
por
Larson Guimarães
Ao atualizar dados via API do Learning.Rocks, é possível utilizar duas estratégias, cada uma com uma lógica diferente para a atualização dos times.
É possível enviar comandos para os endpoints de USERS ou para os endpoints de TEAMS.
Lógica do endpoint de USERS
Clicando aqui você pode acessar a collection completa de USERS.
Ao atualizar informações via endpoints de USERS, a plataforma considera como verdade absoluta os times listados no último comando de atualização — independentemente dos times aos quais o usuário pertencia anteriormente.
Ou seja, se for necessário adicionar um usuário a um novo time, é preciso manter também os IDs dos times dos quais ele já faz parte no corpo da requisição enviada à API. Caso apenas o ID do novo time seja informado, o usuário será removido automaticamente dos times anteriores, permanecendo apenas no novo time indicado.
Da mesma forma, se for necessário remover o usuário de um ou mais times, basta enviar no comando da API apenas os IDs dos times que ele deve continuar vinculado — ele será removido automaticamente dos times não listados.
Exemplo de caso de uso: O usuário João fazia parte dos times “Estagiários”, “Onboarding” e “RH”. Após concluir sua trilha de onboarding e ser efetivado como analista na área de RH, ele deve:
- Permanecer no time “RH”;
- Ser removido dos times “Onboarding” e “Estagiários”;
- Ser adicionado ao time “Analistas”.
Para que isso ocorra, a API deve enviar o comando listando apenas os times dos quais ele deve fazer parte. Assim, ele será removido automaticamente dos demais.
Exemplo do body: “team_ids”: [id do time “RH”, id do time “Analistas”,].
Lógica do endpoint de TEAMS
Clicando aqui você pode acessar a collection completa de TEAMS.
Ao utilizar os endpoints de TEAMS, existem comandos específicos para remover ou adicionar usuários a um time. Dessa forma, o usuário será removido ou adicionado apenas ao time listado, sem afetar os demais times aos quais ele já pertence.
Exemplo de caso de uso: O usuário João fazia parte dos times “Estagiários”, “Onboarding” e “RH”. Após concluir sua trilha de onboarding, ele ainda permanece como estagiário na área de RH. Nesse caso, ele precisa apenas ser removido do time “Onboarding”, sem alterar os demais times.
Para isso, basta enviar o comando DELETE ao endpoint de TEAMS, indicando a remoção do usuário do time “Onboarding”.
Exemplo do body: “team_ids”: [id do time “Onboarding”].
