Planfix API task.getMulti: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "{{#seo: |title=Planfix API task.getMulti |titlemode=append |keywords=Planfix, API, getMulti, multi, task, get, api |description=Planfix API task.getMulti }} A function for retrieving multiple task cards. This function lets you get data for up to 100 tasks per request. Request format: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <request method="task.getMulti"> <account></account> <sid></sid> <tasks> <id></id> <id></id> <general></general>...")
 
 
Line 69: Line 69:
== Go To ==
== Go To ==
*[[Planfix API:Tasks]]
*[[Planfix API:Tasks]]
*[[Error codes]]
*[[Error codes XML API v1|Error codes]]
*[[List of functions]]
*[[List of functions]]

Latest revision as of 09:38, 6 March 2024

A function for retrieving multiple task cards. This function lets you get data for up to 100 tasks per request. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.getMulti">
  <account></account>
  <sid></sid>
  <tasks>
    <id></id>
    <id></id>
    <general></general>
    <general></general>
    <!-- ... -->
  </tasks>
  <signature></signature>
</request>
Name Type Value Notes
tasks.id int IDs of the tasks you would like to receive information about
tasks.general int the numbers of the tasks you would like to receive information about
signature string(32) request signature


When the function executes successfully, the response will look as follows:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <tasks count="count">
    <task>
      <id></id>
      <!-- ... -->
    </task>
    <!-- ... -->
  </tasks>
</response>
Name Type Value Notes
tasks root element, contains a list of tasks
tasks count int number of tasks returned as a result of executing the function
task task see the section on the response to retrieving a task card for a description of this parameter


Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Go To