Knowledge Base: users.index

users.index

Method Type: GET
Required Parameters: none
Optional Parameters: page

Displays the last 20 users to register for Ember

Optional Parameters

page:       Returns the next 20 users. [int]

Usage

http://api.emberapp.com/users/index

// Pagination.
http://api.emberapp.com/users/index?page={page}

// Example: To get the next twenty users add a page url segment.
http://api.emberapp.com/users/index?page=2

Response

Each image is returned in an images array with the following parameters.

user:

username:       Users username and unique identifier. [string]
fullname:       Users fullname. [string]
bio:            Users bio. [string]
url:            Users homepage. [string]
created:        Unix timestamp user joined Ember. [int]
subscriber:     True if the user currently has a subscription. [bool]
total_images:   Total images the user has uploaded to Ember. [int]
total_followers:Total followers the user has.
total_following:Total users the current user is following.
avatar:         Array containing the medium avatar information. [array]

avatar:

size:           Size flag of the image (s, m, l). [string]
width:          Width in px of the avatar image. [int]
height:         Height in px of the avatar image. [int]
filesize:       Size in bytes of the avatar file. [int]
src:            Url to the image file for the avatar. [string]

Example XML Response

<response>
    <status code='0'>OK</status>
    <api>ember.users.index</api>
    <users>
        <user>
            <username>ac94</username>
            <fullname>Aron</fullname>
            <bio>I'm a web developer at Realmac Software</bio>
            <url>http://www.emberapp.com</url>
            <created>1224762809</created>
            <subscriber>1</subscriber>
            <total_images>123</total_images>
            <total_followers>0</total_followers>
            <total_following>0</total_following>
            <avatar>
                <size>m</size>
                <width>75</width>
                <height>75</height>
                <filesize>9953</filesize>
                <src>http://emberapp.com/ac94/avatars/m.png</src>
            </avatar>
        </user>
        <user>
            <username>ben</username>
            <fullname>Ben Counsell</fullname>
            <bio/>
            <url>http://www.realmacsoftware.com</url>
            <subscriber>0</subscriber>
            <created>1224762809</created>
            <total_images>32</total_images>
            <total_followers>0</total_followers>
            <total_following>0</total_following>
            <avatar>
                <size>m</size>
                <width>75</width>
                <height>75</height>
                <filesize>9953</filesize>
                <src>http://emberapp.com/ben/avatars/m.png</src>
            </avatar>
        </user>
    </users>
</resonse>