API
From FreeDESK
(Difference between revisions)
(Created page with "The following is a list of API calls that can be made to the API via HTTP(S). Data can be passed either in the query string (GET) or as POST data. Returned data will be in XM...") |
|||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
The following is a list of API calls that can be made to the API via HTTP(S). | The following is a list of API calls that can be made to the API via HTTP(S). | ||
| − | Data can be passed either in the query string (GET) or as POST data. Returned data will be in XML as described for each individual call. The type of call | + | Data can be passed either in the query string (GET) or as POST data. Returned data will be in XML as described for each individual call. The type of call is specified with the mode parameter. For all calls other than login an SID must be passed of a valid session. |
The API script is api.php so requests are made to <nowiki>http://your.freedesk.path/api.php</nowiki> | The API script is api.php so requests are made to <nowiki>http://your.freedesk.path/api.php</nowiki> | ||
| Line 11: | Line 11: | ||
* [[API requests_assigned|requests_assigned]] - list of requests assigned to a specific user/team or combination | * [[API requests_assigned|requests_assigned]] - list of requests assigned to a specific user/team or combination | ||
* [[API entity_search|entity_search]] - search a data entity | * [[API entity_search|entity_search]] - search a data entity | ||
| + | * [[API entity_save|entity_save]] - save an entity | ||
| + | * [[API entity_create|entity_create]] - create an entity | ||
| + | * [[API request_create|request_create]] - create a request | ||
| + | * [[API request_update|request_update]] - update a request | ||
| + | |||
| + | For other built-in modes consult the source code directly. | ||
Latest revision as of 19:04, 21 August 2012
The following is a list of API calls that can be made to the API via HTTP(S).
Data can be passed either in the query string (GET) or as POST data. Returned data will be in XML as described for each individual call. The type of call is specified with the mode parameter. For all calls other than login an SID must be passed of a valid session.
The API script is api.php so requests are made to http://your.freedesk.path/api.php
[edit] HTTP API Calls
- login - open a user session to the system
- logout - close a current session
- requests_assigned - list of requests assigned to a specific user/team or combination
- entity_search - search a data entity
- entity_save - save an entity
- entity_create - create an entity
- request_create - create a request
- request_update - update a request
For other built-in modes consult the source code directly.
