API login
From FreeDESK
(Difference between revisions)
| Line 6: | Line 6: | ||
| returned = XML login error or session data | | returned = XML login error or session data | ||
}} | }} | ||
| + | This article details a FreeDESK [[API]] call. | ||
= Description = | = Description = | ||
The login call allows the establishment of a ContextType::User session | The login call allows the establishment of a ContextType::User session | ||
| Line 13: | Line 14: | ||
* password : Analyst password | * password : Analyst password | ||
For example | For example | ||
| − | api.php?username=someuser&password=theirpassword | + | api.php?mode=login&username=someuser&password=theirpassword |
= Returned Data = | = Returned Data = | ||
XML containing either the SID on success or a [[API XML Error|FreeDESK error on failure]]. | XML containing either the SID on success or a [[API XML Error|FreeDESK error on failure]]. | ||
Latest revision as of 18:49, 21 August 2012
| login | |
| Call/Mode: | login |
|---|---|
| Description: | Open a user session |
| Parameters: | username, password |
| Returned Data: | XML login error or session data |
This article details a FreeDESK API call.
[edit] Description
The login call allows the establishment of a ContextType::User session
[edit] Using the Call
Pass in the following parameters using GET or POST
- username : Analyst username
- password : Analyst password
For example
api.php?mode=login&username=someuser&password=theirpassword
[edit] Returned Data
XML containing either the SID on success or a FreeDESK error on failure.
