Atualização dos dados de um canal preexistente
Para o uso desse endpoint é necessário que suas credenciais de acesso tenham permissão para o uso do OAuth 2.0 para autorização.
post
https://eduplay.rnp.br/services
/userchannel/update/{identifierOrigin}
Considerações sobre os metadados para o novo canal:
- As informações obrigatórias são:
name
evisibility
. - É possível enviar a opção
removeAllMembers
para definir que todos os membros atuais do canal (caso existam) devem ser removidos. - É possível definir as seguintes opções de visibilidade:
- PUBLIC - acesso público tanto pelo eduplay como por embed
- PRIVATE - acesso apenas a usuários autenticados no eduplay.
- É possível definir uma lista de membros aos quais o canal deve ser associado, por meio do elemento
members
. As informações deemail
etype
são obrigatórias. O e-mail do membro enviado deve pertence a um usuário com conta ativa no eduplay. Os tipos de membros podem ser:- VIEWER - acesso aos conteúdos restritos ao canal;
- PUBLISHER - além de acessar os conteúdos restritos, pode cadastrar novos conteúdos e gerenciar os conteúdos existentes no canal;
- ADMIN - além de ter as mesmas funcionalidades do PUBLISHER, pode gerenciar os demais membros do canal.
- No caso da edição, na lista de membros pode ser definido se um membro atual deve ser removido com o atributo
removeMember
ou se o tipo do membro atual deve ser alterado com o atributochangeType
. Se nenhum dos dois parâmetros for enviado é considerado que trata-se da adição de um novo membro. - Exemplo de definição do elemento
members
em formato XML:<members><member><type>ADMIN</type><email>[email protected]</email><changeType>true</changeType></member><member><type>VIEWER</type><email>[email protected]</email><removeMember>true</removeMember></member></members>
Last modified 1yr ago