Technical Interface

XML Message Format

Each message must:
▪ be well-formed XML
▪ begin with an XML declaration that specifies
▪ the XML version (1.0)
▪ the encoding (optional, iso-8859-1 and utf-8 are supported)

The message format is loosely based on XML-RPC. It supports named parameters with types that are not
defined globally but rather on a per method basis. Naming conventions also differ from XML-PRC.

Request

The root element of the method request is , and the name of the method is given as a string in
the first level child element . The method parameters are given in the first level child element
. The method parameters are specific to each method.

XML request example:

<?xml version="1.0"?>
<methodcall>
  <name>add_task</name>
  <params>
    <taskgroup_id>123004</taskgroup_id>
    <tasks>
      <task>
        <task_id>420233</task_id>
        <bin_id>23255</bin_id>
      </task>
    </tasks>
  </params>
</methodcall>

Response

The root element of the returned XML document is always .

If the method call is successful, a child element named will be created. It contains the returned
data. If no data is returned, will be empty.

XML response example:

<?xml version="1.0"?>
<response>
  <params/>
</response>

If the method call is not successful a child element named will be created . It will contain another
child element named <!code!> that contains the numeric error code.

XML fault response example:

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

Using the AutoStore Interface

Messages are sent as HTTP POST requests to one of the following URLs:

🚧

WARNING

Never use Task Interface and Bin Interface in the same implementation!