Web Services

{{Box
 | BoxBGColor = #FDFDFD
 | BoxFontColor = black
 | BoxBorder = 1px solid #E5E5E5
 | BoxWidth = 100%
 | BoxMargin = 0
}}
{{Bloc
 | BlocWidth = 16%
 | BlocMargin = auto
 | BlocPadding = 0
 | BlocDisplay = inline-block
}}
__TOC__
{{BlocEnd}}<!--
-->{{Bloc
 | BlocWidth = 84%
 | BlocMargin = auto
 | BlocPadding = 0
 | BlocDisplay = inline-block
}}
== Prerequisites == 
{{Bloc
 | BlocWidth = 100%
 | BlocMargin = auto
 | BlocPadding = 0 8px
 | BlocDisplay = block
}}
Before interrogating web services, it is necessary to congfigure and get the SOAP server client token, version 1.2.

Be sure to enable SOAP Extension in your php.ini file and before send any request get the client token with this call :

 $wsdl = "http://127.0.0.1/MapWebFiles/module/Soap/MapSoap.wsdl";     <span style="color:#009900"> // WSDL path : http://<your_server_adress>/MapWebFiles/module/Soap/MapSoap.wsdl </span>
 $client = new SoapClient($wsdl , array("soap_version" => SOAP_1_2)); <span style="color:#009900"> // Mapweb / M-Storage Web need SOAP version 1.2 </span>

For examples below, each call to web service function will be done with the client token.
{{BlocEnd}}
== Functions ==
{{Bloc
 | BlocWidth = 100%
 | BlocMargin = auto
 | BlocPadding = 0 8px
 | BlocDisplay = block
}}
=== getCriteres ===
Récupère la liste des critères disponibles en fonction du ou des volumes passés en paramètres. Les volumes ne sont pas obligatoires.

'''HTTP Method''' : POST

==== Parameters ==== 
{|  border="1" cellpadding="6" style="border-collapse: collapse; margin: 10px 0; border-color: #3366CC;"
|-
! Parameter Name !! Type !! Required !! Description
|-
| login || String || Y || User login
|-
| passwd || String || Y || User password '''encrypted md5'''
|-
| volumes || Array[String] || N || Volumes list
|}
==== Example Webservice Call ====
* PHP
 <span style="color:#009900">/* Set parameters to provide to getCriteres() function  */</span>
 $parameters = array(
               "login" => "userLogin",            <span style="color:#009900"> // User login </span>
               "passwd" => md5("userPassword"),   <span style="color:#009900"> // User password encrypted md5 </span>
                "volumes" => array(               <span style="color:#009900"> // 'Volumes' list, can be defined with getVolumes() </span>
                             "Invoices",
                             "Templates",
                             "Others"
                             );
                );
 <br />
 $aCriteria = $client -> getCriteres($parameters); <span style="color:#009900"> // $aCriteria is an array, see Example Webservice Response in this chapter for more details.</span>
==== Example Webservice Response ====
* PHP
 getCriteresResult  => 
 array(
   Critere => 
   array(
     "m_critere"        => "c_date",    <span style="color:#009900">// Criterion name </span>
     "m_type"           => "varchar",   <span style="color:#009900">// Variable type </span>
     "m_format"         => "",          <span style="color:#009900">// Value format, Ex: Azaz09 </span>
     "m_description"    => "date",      <span style="color:#009900">// Criterion description </span>
     "m_visu"           => "vu",        <span style="color:#009900">// Define if the criterion is hide or visible </span>
     "m_visuSearch"     => ""           <span style="color:#009900">// Define if the crierion is hide or visible for a search </span>
   );
 );

==== Tips ====
* PHP
 <span style="color:#009900">/* $aCriteria contains, for each criterion, all availables values. Here an example to only retrieve names value, see Example Webservice Response in this chapter for more details about availables values */</span>
 $aCriteriaNames = array();
 if(count($aCriteria->getCriteresResult->Critere) > 1)   <span style="color:#009900"> // If the web service returned criterias </span>
 {
   foreach($aCriteria->getCriteresResult as $criterion)
   {
     array_push($aCriteriaNames, $criterion->m_critere); <span style="color:#009900"> // For each criterion, push the name value to array $aCriteriaNames</span>
   }
 }
==== Error Messages ====
<span style="color:#EE0000">'''Modifiable selon la gestion des erreurs'''</span>
 {
    "exception": "invalid_parameter_exception",
    "errorcode": "invalidparameter",
    "message": "Invalid parameter value detected"
 }
{{BlocEnd}}
{{BlocEnd}}
{{BoxEnd}}