eggbird
software development and
knowledge engineering

Mail

ROIS

Query

A client application sends a request to ROIS over the TCP/IP socket as a piece of XML. A request for the list of available projects for user user_name would look like this:

<ROIS>
  <Query task="getProjects">
    <Text>user_name</Text>
  </Query>
</ROIS>
The indentation is only there to make this more (human) readable. In reality, this would be a single line of text.

As soon as ROIS 'sees' the closing </ROIS> tag, it starts sending a reply. This reply might just be the word OK, or when the request asked for information it is a piece of XML. The request for the available projects might return something like this:

<ROIS>
  <Reply task="getProjects">
    <Text>Demo</Text>
    <Text>Trial</Text>
    <Text>Trial2</Text>
  </Reply>
</ROIS>

In the examples above, the task getProjects is one of the tasks that are built-in to ROIS. Below is the list of the built-in tasks.