Avatar

Use este recurso para recuperar um avatar correspondente ao parâmetro avatarId ou um avatar padrão, se o parâmetro avatarId não foi localizado ou não foi fornecido.

Observação: Documentação da API migrada para IBM Central de API O link externo abre uma nova janela ou guia. Encontre as atualizações e a documentação mais recentes para Blueworks Live APIs no API Hub.

Resumo do método

Método de HTTP Caminho Descrição
GET /scr/api/Avatar Recupera um avatar correspondente ao parâmetro avatarId ou um avatar padrão, se o parâmetro avatarId não foi localizado ou não foi fornecido.

GET /scr/api/Avatar

Descrição
Use esse método para recuperar um avatar correspondente ao parâmetro avatarId ou um avatar padrão, se o parâmetro avatarId não foi localizado ou não foi fornecido.
Informações de recurso
Requisitos Descrição
Formato de resposta Dados de imagem
Requer autenticação True
Suporta credenciais do cliente OAuth 2 Sim usando um ID de Serviço do Usuário contendo a Categoria de Gerenciamento do Usuário
Taxa limitada Ainda não
Parâmetros
Nome Local Descrição Necessário Tipo
avatarId Consultar O ID do avatar para download.
Uma imagem do avatar padrão será retornada nos seguintes casos:
  • Quando avatarId não é fornecido
  • Quando um avatarId é fornecido, mas um avatar correspondente ao ID não é localizado
 Não Sequência
location Consultar Indica o local no qual a imagem é exibida no IBM Blueworks Live Cada local retorna um avatar em um tamanho da imagem diferente. Se o valor do local não for fornecido, a imagem será retornada no tamanho padrão de 85 x 85 pixels. Os valores possíveis incluem:
  • chat (20 x 20 pixels)
  • comments (30 x 30 pixels)
  • news (40 x 40 pixels)
  • settings (85 x 85 pixels)
 Não Sequência
Resposta
Exemplo de entrada
  • Usando credenciais do cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/scr/api/Avatar?avatarId=a0777"
Exemplo de saída
Dados de imagem para o avatar.
Propriedades de resposta
Nenhum
Mensagens de resposta
Código de HTTP Razão
200

A solicitação foi concluída com sucesso.
401

O usuário não está autorizado a fazer a solicitação.