Avatar

Utilice este recurso para recuperar un avatar correspondiente al parámetro avatarId o un avatar predeterminado, si el parámetro avatarId no se ha encontrado o no se ha proporcionado.

Nota: La documentación de la API se ha migrado a IBM API Hub El enlace externo abre una nueva ventana o pestaña. Encuentre las últimas actualizaciones y documentación sobre Blueworks Live API en API Hub.

Resumen del método

Método HTTP Vía de acceso Descripción
GET /scr/api/Avatar Recupera un avatar correspondiente al parámetro avatarId o un avatar predeterminado, si el parámetro avatarId no se ha encontrado o no se ha proporcionado.

GET/scr/api/Avatar

Descripción
Utilice este método para recuperar un avatar correspondiente al parámetro avatarId o un avatar predeterminado, si el parámetro avatarId no se ha encontrado o no se ha proporcionado.
Información de recursos
Requisitos Descripción
Formato de la respuesta Datos de imagen
Requiere autenticación Sí
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de usuarios
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
avatarId Consulta ID del avatar a descargar.
Se devuelve una imagen del avatar predeterminado en los casos siguientes:
  • Cuando no se proporciona el avatarId
  • Cuando se proporciona un avatarId pero no se encuentra ningún avatar que coincida con el ID.
 Nee Serie
location Consulta Indica la ubicación donde se muestra la imagen en IBM Blueworks Live. Cada ubicación devuelve un avatar en un tamaño de imagen diferente. Si no se proporciona el valor de ubicación, la imagen se devuelve en el tamaño predeterminado de 85 x 85 píxeles. Los valores posibles incluyen:
  • chat (20 x 20 píxeles)
  • comments (30 x 30 píxeles)
  • news (40 x 40 píxeles)
  • settings (85 x 85 píxeles)
 Nee Serie
Respuesta
Entrada de ejemplo
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/scr/api/Avatar?avatarId=a0777"
Resultado de ejemplo
Datos de imagen para el avatar.
Propiedades de respuesta
Ninguna
Mensajes de respuesta
Código HTTP Razón
200

La solicitud se ha completado correctamente.
401

El usuario no está autorizado a realizar la petición.