Forecast Bin

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`bin_id`	False	Int (1-4000000)	If the parameter `bin_id` is provided, only that specific Bin will be requested to enter mode forecast. It is possible to provide multiple `bin_id` elements, in order to request an array of Bins to enter mode forecast. The maximum number of Bins that can be requested to enter mode forecast in one array is 10000.
`min_bin_id`	False	Int (1-4000000)	If the parameter `min_bin_id` is provided, only Bins with `bin_id` greater than or equal to `min_bin_id`, and `bin_id` less than or equal to `max_bin_id`, are requested to enter mode forecast. The maximum number of Bins that can be requested to enter mode forecast is 10000, meaning that the difference between `min_bin_id` and `max_bin_id` can be no more than 10000.
`max_bin_id`	False	Int (1-4000000)	If the parameter `max_bin_id` is provided, only Bins with `bin_id` less than or equal to `max_bin_id`, and `bin_id` greater than or equal to `min_bin_id`, are requested to enter mode forecast. The maximum number of Bins that can be requested to enter mode forecast is 10000, meaning that the difference between `max_bin_id` and `min_bin_id` can be no more than 10000.

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>forecastbin</name>
  <params>
    <min_bin_id>14860</min_bin_id>
    <max_bin_id>14865</max_bin_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>forecastbin</name>
  <params>
    <min_bin_id>14860</min_bin_id>
    <max_bin_id>14865</max_bin_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>forecastbin</name>
  <params>
    <min_bin_id>14860</min_bin_id>
    <max_bin_id>14865</max_bin_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>forecastbin</name>
  <params>
    <min_bin_id>14860</min_bin_id>
    <max_bin_id>14865</max_bin_id>
  </params>
</methodcall>

{
    "method": "forecastbin",
    "params": {
        "min_bin_id": 14860,
        "max_bin_id": 14865
    }
}

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
1010	Parameter bin_id is not valid (invalid format or out of range).
1011	The specified Bin does not exist.
1024	Mandatory parameter bin_id is missing.
1049	Response overflow.
1078	Bin is in Port. The messages forecastbin and cancelforecastbin will be rejected if the Bin is in a Port.
1079	Illegal Bin mode. The message forecastbin will be rejected if the current bin mode is not GRID. The cancelforecastbin will be rejected if the current bin mode is not FORECAST.
1080	Method is not supported. The method is not supported by some of the other modules. For example, the method may requires a newer version of AutoStore Driver or AutoStore Planner.

Software version requirement

Software Release October 2022 and newer