Version 1.1

/Mobile/ login/

Inputs

Input Input Definition Required Detailed Description
username The username to login Yes
password The user's password to login Yes
type used to determine JSON or XML No If parameter is not passed than it will assume JSON.


Ouputs


Response Response Definition Detailed Description
statusCode The status code for the returned result. (In this case should always be Success
statusMessage The message that describes the associated status code.
userid The user's userid (uid) Used for whenever an API requires uid
sessionid The session id for this user You have to pass this anytime the API requieres a session id, which is usually for any action done to the site that would require a user.

Sample Outputs

JSON

{"response":
  {"status":
    {"statusCode":1,
    "statusMessage":"Success!"},
    "login":
      {"userid":"1",
      "sessionid":"rg2idm0fpbtra5rvegi0e2njt3"} 
  } 
}

XML

<?xml version="1.0" encoding="UTF-8"?> 
<response>
  <status>
    <statusCode>1</statusCode>
    <statusMessage>Success!</statusMessage>
  </status>
  <login>
    <userid>1</userid>
    <sessionid>rg2idm0fpbtra5rvegi0e2njt3</sessionid> 
  </login>
</response> 

Last edited Feb 21, 2012 at 6:32 PM by darxval, version 6

Comments

No comments yet.