MovimRPC consists in sending XML-formatted strings that describe a function call. Both communicating systems need to be aware of each other’s functions set as no return is available on a function call.

Instead of returning data after a function call, the called system triggers a movimRPC call to the calling system, feeding it the appropriate data as paramaters.

Messy strings parameters (e.g. those containing HTML code) need to be enclosed in CDATA markups.

One MovimRPC document can contain more than one function call. All function calls need to be enclosed in <movimcontainer> tags. Function calls are defined with the <funcall>. Each function parameter is enclosed in <param> tags.

Function calls must have a NAME parameter, and accept a WIDGET parameter.

Here is an example of a call to the function myfunc of the widget MyWidget with the relevant parameters.

<?xml version="1.0" encoding="UTF-8" ?>
<movimcontainer>
  <funcall name="myfunc" widget="MyWidget">
    <param>foo</param>
    <param>bar</param>
  </funcall>
</movimcontainer>

The parameters passed to a function aren't typed. The required type needs to be known by the caller.

Arrays can be passed within parameters. Arrays may be associative or mixed or not. They are declared within <array> tags. Each element in the array is enclosed by <arrayelt> tags. Elements can be associated to a key with the NAME parameter.

An example of two function calls with an associative array.

<?xml version="1.0" encoding="UTF-8" ?>
<movimcontainer>
  <funcall name="myfunc" widget="MyWidget">
    <param>foo</param>
    <param>bar</param>
  </funcall>
  <funcall name="toto">
    <param>foo</param>
    <param>
      <array>
        <arrayelt name="elt1">1</arrayelt>
        <arrayelt name="2">associative</arrayelt>
        <arrayelt>sequential</arrayelt>
      </array>
    </param>
  </funcall>
</movimcontainer>