<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % cartoweb SYSTEM "../../cartoweb.ent" >
  %cartoweb;
  ]>
<sect2 id="dev.soapcalls.getmap.global">
  <title>Global Structures</title>
  <para>Below is a description of general requests and results which include 
    plugin-specific ones.</para>
  <sect3 id="dev.soapcalls.getmap.global.request">
    <title>Global Request</title>
    <para>
      <programlisting><![CDATA[
<complexType name="MapRequest">
  <all>
    <element name="mapId" type="xsd:string"/>
    ...elements specific to plugins...
  </all>
</complexType>]]></programlisting>
      <itemizedlist>
        <listitem>
          <para>mapId - map ID, ie. project name and mapfile name separated by 
            a point</para>
        </listitem>
      </itemizedlist>
    </para>
  </sect3>
  <sect3 id="dev.soapcalls.getmap.global.result">
    <title>Global Result</title>
    <para>
      <programlisting><![CDATA[
<complexType name="Message">
  <all>
    <element name="channel" type="xsd:integer"/>
    <element name="message" type="xsd:string"/>
  </all>
</complexType>]]></programlisting>
      <itemizedlist>
        <listitem>
          <para>channel - type of message: 1 = end user, 2 = developer</para>
        </listitem>
        <listitem>
          <para>message - text of the message</para>
        </listitem>
      </itemizedlist>
      <programlisting><![CDATA[
<complexType name="ArrayOfMessage">
  <complexContent>
    <restriction base="enc11:Array">
      <attribute ref="enc11:arrayType" wsdl:arrayType="types:Message[]"/>
    </restriction>
  </complexContent>
</complexType>]]></programlisting>
      <itemizedlist>
        <listitem>
          <para>array - list of messages</para>
        </listitem>
      </itemizedlist>
      <programlisting><![CDATA[
<complexType name="MapResult">
  <all>
    <element name="timestamp" type="xsd:integer"/>
    <element name="serverMessages"
             type="types:ArrayOfMessage" minOccurs="0"/>
    ...elements specific to plugins...
  </all>
</complexType>]]></programlisting>
      <itemizedlist>
        <listitem>
          <para>timestamp - timestamp which identifies the server 
            configuration. If this timestamp changes, it means server 
            configuration changed and a call to method getMapInfo is required 
            to get latest version (see <xref linkend="dev.soapcalls.getmapinfo" 
            />).</para>
        </listitem>
        <listitem>
          <para>serverMessages - list of messages returned by server</para>
        </listitem>
      </itemizedlist>
    </para>
  </sect3>
</sect2>