Home » Documentation » REST API » User API

User API

The User API allows you access to the core attributes of a Mxit user: their profile information, social graph, and their media library on Mxit.

Authorization

The User REST API uses OAuth2 for authorization.  To use a method that requires authorization, you will first need to request an OAuth token using the Mxit Authorization API.

API Version

Resource
Description
OAuth
GET /user/version

Get the current API version.

None

Profile

This is a category with all relevant functions applicable to the User Profile.

Resource
Description
OAuth
GET /user/lookup/{MxitId}

Returns the unique User ID for a Mxit user, using the user's Mxit ID (login name).

profile/public
POST /user/avatar

This method call allows you to upload an avatar image for a Mxit user.

avatar/write
DELETE /user/avatar

This method call allows you to delete the avatar image for a Mxit user. The response and request body for this method are empty. The successful execution of the method is indicated by the HTTP status code of 200 (OK).

avatar/write
GET /user/avatar

This method call allows you to download the avatar image for a Mxit user.

profile/public
GET /user/profile/{userId}

Returns profile and status information for a specified Mxit user.

profile/public
GET /user/profile

This method call allows you to retrieve the profile information for a Mxit user.

profile/private
or
profile/public
PUT /user/profile

This method call allows you to update profile information for a Mxit user.

profile/write
PUT /user/statusmessage

This method call allows you to set the status message for a Mxit user.

status/write
GET /user/statusmessage

This method call allows you to get the status message for a Mxit user.

profile/public
GET /user/public/statusmessage/{mxitId}

This method call allows you to get the status message for a Mxit user.

None
GET /user/public/displayname/{mxitId}

This method call allows you to retrieve an Mxit user’s display name (Nickname).

None
GET /user/public/avatar/{mxitId}

This method call allows you to download the avatar image for a Mxit user.

If the user does not have an avatar, a default avatar image will be returned.

None

Media

All relevant functions for users to share content, images, music, etc.

Resource
Description
OAuth
GET /user/media/

This method allows you to retrieve a list of Gallery folders of a Mxit user.

content/read
POST /user/media/{folderName}

This method allows you to create a Gallery folder for a Mxit user.

content/write
DELETE /user/media/{folderName}

This method allows you to delete a Gallery folder for a Mxit user.  All the files in the folder will also be deleted.

content/write
PUT /user/media/{folderName}

This method allows you to rename a Gallery folder for a Mxit user.

content/write
DELETE /user/media/file/{fileId}

This method allows you to delete a Gallery file for a Mxit user.

content/write
PUT /user/media/file/{fileId}

This method allows you to rename a Gallery file for a Mxit user.

content/write
POST /user/media/file/{folderName} ...

This method allows you to upload a file to the specified Gallery folder for a Mxit user.

content/write
GET /user/media/list/{folderName} ...

This method allows you to retrieve a list of content items in the specified Gallery folder of a Mxit user.  Only user generated items are added to the list.

content/read
GET /user/media/content/{fileId}

This method allows you to download the content of a Gallery file for a Mxit user.

content/read