Users.getLoggedInUser

This method/service call returns a array with the user information.


Syntax

mixed users.getLoggedInUser ( int NA = NULL )

Arguments

NameTypeRequiredDefault valueDescription
NAintOptionalNULLThis method does not take any arguments and will simply return the user information, listed below, for the current logged in user.

Response

Below you will find a list and description of all of the available fields to have returned with the users.getUserBySessionToken service.

NameTypeDescription
idINTThe user id for the requested user.
userSTRINGThe username for the requested user.
passwordSTRINGAn encrypted hash containing the user's password.
emailSTRINGThe e-mail address for the requested user.
firstnameSTRINGThe first name of the requested user.
lastnameSTRINGThe last name for the requested user.
citySTRINGThe city for the requested user.
genderCHARThe gender of the requested user.
birthdateDATEThe birthdate of the requested user.
cellphoneSTRINGThe users cell phone number.
phoneSTRINGThe users telephone number.
websiteSTRINGThe users website.
occupationSTRINGThe users occupation.
address1STRINGThe first line of the users address.
address2STRINGThe second line of the users address.
postalcodeSTRINGThe postal code of the requested user.
stateSTRINGThe state of the requested user.
languageSTRINGThe requested users language.
countrySTRINGThe requested users country.
descriptionSTRINGA description of the requested user.
storageINT??
avatarINTAn integer for the media item of the requested users avatar.
createdDATETIMEThe date and time that the user was created.
lastloginDATETIMEThe date and time that the user was last logged into the system.
random1INTA random number used for activating the account.
random2INTA random number used for activating the account.
accounttypeINTNot currently implemented.
activeBOOLEANWhether or not the requested user is activated.
disabledBOOLEANWhether or not the requested user's account is disabled.
newsletterBOOLEANWhether or not the requested user has requested the newsletter. 0 is false, 1 is true.
nicknameSTRINGThe requested users nickname.
attemptsINTThe number of login attempts for the user since the last successful login.
mobileblogSTRINGA url for a mobile blog for the requested user.
publicfilesINTThe number of media items that user has uploaded to the system.
NOTE: You can find the value of notdeniedfiles by subtracting deniedfiles from publicfiles.
unmoderatedfilesINTThe number of media items the user has uploaded to the system that have yet to be moderated.
approvedfilesINTThe number of media items that the user has uploaded to the system that have been approved.
deniedfilesINTThe number of media items uploaded by the user that have been denied.
unmoderatedcommentsINTThe number of comments the user has posted that have yet to be moderated.
approvedcommentsINTThe number of comments the user has posted that have been approved.
NOTE: You can find the value of notdeniedcomments by calculating the sum of approvedcomments plus unmoderatedcomments.
deniedcommentsINTThe number of comments the user has posted that have been denied.
notdeniedcommentsINTThe number of comments the user has posted that have been approved or have yet to be mopderated.
friendsSTRINGThe number of users that have confirmed knowing this user.
friends_notconfirmedSTRINGThe number of users that have yet to confirm knowing this user.
geo_latitudeFLOATThe geographical latitude for the requested user.
geo_longitudeFLOATThe geographical longitude for the requested user.
vhostINTThe vhost for the requested user.
metaARRAYAny meta data that has been collected about the requested user.
no_comment_notificationsINTSet to 1 to prevent the user from receiving comment notifications. Set to 0 to allow the user to receive them.
profile_completeBOOLEANWhether or not the requested user has a complete profile.
externalidsARRAYThe user's external IDs, if any.

Sample Response

Sample REST Response
http://api.filemobile.com/services/rest/users/getLoggedInUser
<?xml version="1.0" encoding="UTF-8"?>
<result>
  <id>USER_ID</id>
  <user>USERNAME</user>
  <email>USER_EMAIL</email>
  <firstname>USER_FIRSTNAME</firstname>
  <lastname>USER_LASTNAME</lastname>
  <city/>
  <gender>M</gender>
  <birthdate>0000-00-00</birthdate>
  <cellphone/>
  <phone/>
  <website/>
  <occupation/>
  <address1/>
  <address2/>
  <postalcode/>
  <state/>
  <language/>
  <country/>
  <description/>
  <storage>152274291</storage>
  <avatar>0</avatar>
  <created>2009-06-23 13:12:54</created>
  <random1>2362</random1>
  <random2>840067486</random2>
  <accounttype>0</accounttype>
  <active>1</active>
  <disabled>0</disabled>
  <newsletter>0</newsletter>
  <openidurl/>
  <nickname/>
  <attempts>0</attempts>
  <mobileblog>0</mobileblog>
  <publicfiles>1085</publicfiles>
  <friends>0</friends>
  <friends_notconfirmed>0</friends_notconfirmed>
  <geo_latitude/>
  <geo_longitude/>
  <vhost>2</vhost>
  <meta>
    <moderationEmail/>
    <commentEmail/>
  </meta>
  <no_comment_notifications>0</no_comment_notifications>
  <profile_complete>0</profile_complete>
  <gravatarid>708e81e8ad320b75d88a39526a539925</gravatarid>
  <externalids/>
</result>
Sample JSON Response
{
    "status": true,
    "result": {
        "id": USER_ID,
        "user": "USERNAME",
        "email": "USER_EMAIL",
        "firstname": "USER_FIRSTNAME",
        "lastname": "USER_LASTNAME",
        "city": "",
        "gender": "M",
        "birthdate": "2008-12-29",
        "cellphone": "",
        "phone": "",
        "website": "",
        "occupation": "",
        "address1": "",
        "address2": "",
        "postalcode": "",
        "state": "",
        "language": "",
        "country": "VE",
        "description": "",
        "storage": 476344888,
        "avatar": 0,
        "created": "2005-10-08 18:46:01",
        "random1": 1,
        "random2": 7500,
        "accounttype": 0,
        "active": "1",
        "disabled": "0",
        "newsletter": "0",
        "openidurl": "",
        "nickname": "public",
        "attempts": 0,
        "mobileblog": 0,
        "publicfiles": 14913,
        "friends": 0,
        "friends_notconfirmed": 0,
        "geo_latitude": null,
        "geo_longitude": null,
        "vhost": 1,
        "meta": [],
        "no_comment_notifications": 0,
        "profile_complete": 0,
        "gravatarid": "ac21ec2a419d33dc5d730e72a0343a08",
        "externalids": []
    }
}

Code examples

0 comments

Be the first to comment on getLoggedInUser.

Add a Comment

  • captcha