API requests assigned

From FreeDESK
(Difference between revisions)
Jump to: navigation, search
(Created page with "{{Infobox API | name = Requests Assigned | mode = requests_assigned | description = Return Requests Assigned to Specific User/Team | parameters = teamid, username, sort, order...")
 

Latest revision as of 18:53, 21 August 2012

Requests Assigned
Call/Mode: requests_assigned
Description: Return Requests Assigned to Specific User/Team
Parameters: teamid, username, sort, order
Returned Data: XML request list

This article details a FreeDESK API call.

[edit] Description

This call allows the fetching of sets of requests assigned to a specific team and/or user

[edit] Using the Call

Pass in the following parameters using GET or POST

  • teamid : Team ID (null or 0 for no team)
  • username : Username of analyst (null or blank for no user)
  • sort : Field name on which to sort the results (blank or null for default)
  • order : A for ASC or D for DESC (optional, defaults to ASC)

For example

api.php?mode=requests_assigned&teamid=3&username=someuser

Would return the requests assigned to someuser 'within' teamid 3

[edit] Returned Data

A request-list block of results

Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox