Tandem Support List

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Created page with "The tandem support list command will returns a list of all tickets for a particular queue. ==Path== */tandem/support/list ==Method== *POST ==Req...")
 
 
Line 10: Line 10:
  
 
==Optional Data Parameters==
 
==Optional Data Parameters==
{$start}: Sets the start number for the amount of support tickets retrieved; the default is 0.  
+
*{$start}: Sets the start number for the amount of support tickets retrieved; the default is 0.
{$limit}: Sets the limit number for the amount of support tickets retrieved; the default is 100.  
+
*{$limit}: Sets the limit number for the amount of support tickets retrieved; the default is 100.
{$query}: Search the subject or body of ticket; default is null.  
+
*{$query}: Search the subject or body of ticket; default is null.
{$type}: open or closed; the default is open.  
+
*{$type}: open or closed; the default is open.
  
 
==Returned Data==
 
==Returned Data==

Latest revision as of 20:07, 14 May 2012

The tandem support list command will returns a list of all tickets for a particular queue.

Contents

Path

  • /tandem/support/list

Method

Required Data Parameters

  • {$queueid}: The queue ID returned using the the tandem support command.

Optional Data Parameters

  • {$start}: Sets the start number for the amount of support tickets retrieved; the default is 0.
  • {$limit}: Sets the limit number for the amount of support tickets retrieved; the default is 100.
  • {$query}: Search the subject or body of ticket; default is null.
  • {$type}: open or closed; the default is open.

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
    [success] => TRUE/FALSE
    [total] => The total number of tickets.
    [tickets] => An array of tickets
  )
)
Personal tools