HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Get Task Information

Endpoint

http://<server>:44000/api/v2/task

Request parameters

ParameterMandatory?Data typeDescription
taskgroup_idFalseInt
(1-2147483647)
If the parameter taskgroup_id is provided, only information about that task group is returned.
min_taskgroup_idFalseInt
(1-2147483647)
If the parameter min_taskgroup_id is provided, only task groups with taskgroup_id greater than or equal to
min_taskgroup_id are returned.
max_taskgroup_idFalseInt
(1-2147483647)
If the parameter max_taskgroup_id is provided, only task groups with taskgroup_id less than or equal to
max_taskgroup_id are returned.
task_idFalseInt
(1-2147483647)
If the parameter task_id is provided, only information about that task is returned. If a task_id is specified, then
a taskgroup_id should not be specified.
categoryFalseInt (1-CATEGORY_MAX)If the parameter category is provided, a list of taskgroups belonging to that category will be returned. (Note: this process can be slow depending on the number of taskgroups in the system).
suspendedFalseBooleanIf the parameter suspended is provided, a list of taskgroups belonging to that suspended state will be returned. (Note: this process can be slow depending on the number of taskgroups in the system).
shipmentFlaseInt (1-2147483647)If the parameter shipment is provided, a list of taskgroups belonging to that shipment will be returned. (Note: this process can be slow depending on the number of taskgroups in the system).

Request example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the task interface
string url = "http://" + ip + ":44000/api/v2/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>gettaskinfo</name>
  <params>
    <taskgroup_id>134523</taskgroup_id>
  </params>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44000/api/v2/task"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>gettaskinfo</name>
  <params>
    <taskgroup_id>134523</taskgroup_id>
  </params>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)
const ip = "127.0.0.1";
const url = `http://${ip}:44000/api/v2/task`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>gettaskinfo</name>
  <params>
    <taskgroup_id>134523</taskgroup_id>
  </params>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));
<?xml version="1.0"?>
<methodcall>
  <name>gettaskinfo</name>
  <params>
    <taskgroup_id>134523</taskgroup_id>
  </params>
</methodcall>

Response parameters

ParameterData typeDescription
taskgroup_idInt
(1-2147483647)
Identifies the task group.
shipmentInt
(1-2147483647)
The shipment the task group belongs to.
categoryInt
(1-CATEGORY_MAX)
The category the task group belongs to.
req_timeDate and time.
Between 1971.01.01 and 2038.01.18.
The task group's req_time property.
priorityInt
(1-2147483647)
The task group's priority property.
start_timeDate and time.
Between 1971.01.01 and 2038.01.18.
The task group's start_time property.
suspendedBooleanTells if the task group has been suspended or not.
task_idInt
(1-2147483647)
Identifies the specific task.
bin_idInt
(1-4000000)
The Bin which belongs to this task.
itemInt
(1-2147483647)
The task's item property.
orderInt
(1-2147483647)
The task's order property.
estpicktimeInt
(1-2147483647)
The task's estimated handling time, specified in seconds.

Response example

<?xml version="1.0"?>
<response>
  <params>
    <taskgroups>
      <taskgroup>
        <taskgroup_id>134523</taskgroup_id>
        <shipment>20961</shipment>
        <category>1</category>
        <req_time>2009-03-20T14:00:00Z</req_time>
        <priority>20</priority>
        <tasks>
          <task>
            <task_id>420192</task_id>
            <bin_id>10304</bin_id>
          </task>
          <task>
            <task_id>420193</task_id>
            <bin_id>33570</bin_id>
          </task>
        </tasks>
      </taskgroup>
    </taskgroups>
  </params>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Error CodeDescription
1012Parameter task_id is not valid (invalid format or out of range).
1013Parameter taskgroup_id is not valid (invalid format or out of range).
1017The specified task does not exist.
1018The specified task group does not exist.
1023Multiple selection parameters are not allowed.
1049Response overflow.

Software version requirement

Software Release October 2022 and newer