Show Pick-To-Light
Requires router softwareWARNING: This feature requires router software!
Endpoint
http://<server>:44000/api/v2/task
Request parameters
| Parameter | Mandatory? | Data type | Description |
|---|---|---|---|
| source_port_id | True | Int (1-2000) | Identifies the source port. |
| target_port_id | False | Int (1-2000) | Identifies the target port. |
| source_bin_id | True | Int (1-4000000) | Identifies the source bin. |
| target_bin_id | False | Int (1-4000000) | Identifies the target bin. |
| source_compartment | True | Int (Calculated) | Identifies the source compartment. See PTL Compartment Calculation. |
| target_compartment | False | Int (Calculated) | Identifies the target compartment. See PTL Compartment Calculation. |
| quantity | True | Int (0-1000) | Number of items to pick. |
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>showpicktolight</name>
<params>
<source_port_id>3</source_port_id>
<target_port_id>4</target_port_id>
<source_bin_id>15575</source_bin_id>
<target_bin_id>20501</target_bin_id>
<source_compartment>83</source_compartment>
<target_compartment>11</target_compartment>
<quantity>1</quantity>
</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>showpicktolight</name>
<params>
<source_port_id>3</source_port_id>
<target_port_id>4</target_port_id>
<source_bin_id>15575</source_bin_id>
<target_bin_id>20501</target_bin_id>
<source_compartment>83</source_compartment>
<target_compartment>11</target_compartment>
<quantity>1</quantity>
</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>showpicktolight</name>
<params>
<source_port_id>3</source_port_id>
<target_port_id>4</target_port_id>
<source_bin_id>15575</source_bin_id>
<target_bin_id>20501</target_bin_id>
<source_compartment>83</source_compartment>
<target_compartment>11</target_compartment>
<quantity>1</quantity>
</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>showpicktolight</name>
<params>
<source_port_id>3</source_port_id>
<target_port_id>4</target_port_id>
<source_bin_id>15575</source_bin_id>
<target_bin_id>20501</target_bin_id>
<source_compartment>83</source_compartment>
<target_compartment>11</target_compartment>
<quantity>1</quantity>
</params>
</methodcall>Response parameters
This method has no response parameters.
Response example
<?xml version="1.0"?>
<response>
<params/>
</response>
OR
<?xml version="1.0"?>
<response>
<fault>
<code>1000</code>
</fault>
</response>Error Codes
| Error Code | Description |
|---|---|
| 1002 | The specified Port is already open. |
| 1003 | Mandatory parameter port_id is missing. |
| 1004 | Parameter port_id is not valid (invalid format or out of range). |
| 1105 | Parameter target_port_id is not valid (invalid format or out of range), the target port is not open, is not a supported port type or does not belong to the same workstation. |
| 1006 | Parameter content is not valid (invalid format or out of range). |
| 1007 | Parameter category is not valid (invalid format or out of range). |
| 1008 | Parameter req_time is not valid (invalid format or out of range). |
| 1009 | The specified Port is not open. |
| 1010 | Parameter bin_id is not valid (invalid format or out of range). |
| 1011 | The specified Bin does not exist. |
| 1012 | Parameter task_id is not valid (invalid format or out of range). |
| 1013 | Parameter taskgroup_id is not valid (invalid format or out of range). |
| 1014 | Parameter shipment is not valid (invalid format or out of range). |
| 1015 | There are no tasks or Bins that fulfill the Port select requirements. |
| 1016 | There are no Bins ready that fulfill the Port select requirements. |
| 1017 | The specified task does not exist. |
| 1018 | The specified task group does not exist. |
| 1019 | The specified task group is selected by another Port. |
| 1103 | The source port is not open or is not a supported port type. |
| 1111 | The compartment id is invalid or not supported by the source port. |
| 1113 | The compartment id is invalid or not supported by the target port. |
Software version requirement
Software Release April 2023
Updated 2 months ago