API login

From FreeDESK
(Difference between revisions)
Jump to: navigation, search
(Created page with "{{Infobox API | name = login | mode = login | description = Open a user session | parameters = username, password | returned = XML login error or session data }}")
 
Line 6: Line 6:
 
| returned = XML login error or session data
 
| returned = XML login error or session data
 
}}
 
}}
 +
= Description =
 +
The login call allows the establishment of a ContextType::User session
 +
= Using the Call =
 +
Pass in the following parameters using GET or POST
 +
* username : Analyst username
 +
* password : Analyst password
 +
For example
 +
api.php?username=someuser&password=theirpassword
 +
= Returned Data =
 +
XML containing either the SID on success or a [[API XML Error|FreeDESK error on failure]].

Revision as of 18:29, 21 August 2012

login
Call/Mode: login
Description: Open a user session
Parameters: username, password
Returned Data: XML login error or session data

Description

The login call allows the establishment of a ContextType::User session

Using the Call

Pass in the following parameters using GET or POST

  • username : Analyst username
  • password : Analyst password

For example

api.php?username=someuser&password=theirpassword

Returned Data

XML containing either the SID on success or a FreeDESK error on failure.

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox