API login
From FreeDESK
(Difference between revisions)
(Created page with "{{Infobox API | name = login | mode = login | description = Open a user session | parameters = username, password | returned = XML login error or session data }}") |
|||
| (One intermediate revision by one user not shown) | |||
| 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 = | ||
| + | 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?mode=login&username=someuser&password=theirpassword | ||
| + | = Returned Data = | ||
| + | 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.
