Get Avatars

Description

Retrieves a list of avatars

HTTP Method

GET

Path

/common/avatars

Authentication

Does not require user authentication.

Parameters

Table 22.  Parameters for " Get Avatars "

NameTypeValue TypeDescription
maxResultsQUERYint(optional) maximum number of avatars to be returned, defaults to 100

Error Codes

150000 ( Common )

An unhandled exception has occured.

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="avatars">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="avatar" nillable="true" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="id" type="xs:long"/>
              <xs:element name="name" type="xs:string"/>
              <xs:element name="thumbURL" type="xs:anyURI" minOccurs="0"/>
              <xs:element name="imageURL" type="xs:anyURI" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<avatars xmlns="http://xsd.poken.com">
  <avatar>
    <id>10</id>
    <name>dog</name>
    <thumbURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/dog_thumb.jpg</thumbURL>
    <imageURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/dog.jpg</imageURL>
  </avatar>
  <avatar>
    <id>11</id>
    <name>flower</name>
    <thumbURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/flower_thumb.jpg</thumbURL>
    <imageURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/flower.jpg</imageURL>
  </avatar>
  <avatar>
    <id>12</id>
    <name>tiger</name>
    <thumbURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/tiger_thumb.jpg</thumbURL>
    <imageURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/tiger.jpg</imageURL>
  </avatar>
  <avatar>
    <id>13</id>
    <name>ball</name>
    <thumbURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/ball_thumb.jpg</thumbURL>
    <imageURL>https://d3759s1c6gf66q.cloudfront.net/poken/web/images/default/avatar/ball.jpg</imageURL>
  </avatar>
</avatars>