https://docs.mappingsuite.com/w/index.php?action=history&feed=atom&title=Mapweb_%2F_M-Storage_Web%3A_Web_Services
Mapweb / M-Storage Web: Web Services - Historique des versions
2026-04-06T15:57:41Z
Historique des versions pour cette page sur le wiki
MediaWiki 1.32.1
https://docs.mappingsuite.com/w/index.php?title=Mapweb_/_M-Storage_Web:_Web_Services&diff=1767&oldid=prev
imported>Admin : 1 révision importée
2019-03-06T09:11:40Z
<p>1 révision importée</p>
<table class="diff diff-contentalign-left" data-mw="interface">
<tr class="diff-title" lang="fr">
<td colspan="1" style="background-color: #fff; color: #222; text-align: center;">← Version précédente</td>
<td colspan="1" style="background-color: #fff; color: #222; text-align: center;">Version du 6 mars 2019 à 09:11</td>
</tr><tr><td colspan="2" class="diff-notice" lang="fr"><div class="mw-diff-empty">(Aucune différence)</div>
</td></tr></table>
imported>Admin
https://docs.mappingsuite.com/w/index.php?title=Mapweb_/_M-Storage_Web:_Web_Services&diff=1766&oldid=prev
imported>Bdezeque le 8 février 2017 à 10:04
2017-02-08T10:04:26Z
<p></p>
<p><b>Nouvelle page</b></p><div>{{Box<br />
| BoxBGColor = #FDFDFD<br />
| BoxFontColor = black<br />
| BoxBorder = 1px solid #E5E5E5<br />
| BoxWidth = 100%<br />
| BoxMargin = 0<br />
}}<br />
{{Bloc<br />
| BlocWidth = 16%<br />
| BlocMargin = auto<br />
| BlocPadding = 0<br />
| BlocDisplay = inline-block<br />
}}<br />
__TOC__<br />
{{BlocEnd}}<!--<br />
-->{{Bloc<br />
| BlocWidth = 84%<br />
| BlocMargin = auto<br />
| BlocPadding = 0<br />
| BlocDisplay = inline-block<br />
}}<br />
== Prerequisites == <br />
{{Bloc<br />
| BlocWidth = 100%<br />
| BlocMargin = auto<br />
| BlocPadding = 0 8px<br />
| BlocDisplay = block<br />
}}<br />
Before interrogating web services, it is necessary to congfigure and get the SOAP server client token, version 1.2.<br />
<br />
Be sure to enable SOAP Extension in your php.ini file and before send any request get the client token with this call :<br />
<br />
$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><br />
$client = new SoapClient($wsdl , array("soap_version" => SOAP_1_2)); <span style="color:#009900"> // Mapweb / M-Storage Web need SOAP version 1.2 </span><br />
<br />
For examples below, each call to web service function will be done with the client token.<br />
{{BlocEnd}}<br />
== Functions ==<br />
{{Bloc<br />
| BlocWidth = 100%<br />
| BlocMargin = auto<br />
| BlocPadding = 0 8px<br />
| BlocDisplay = block<br />
}}<br />
=== getCriteres ===<br />
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.<br />
<br />
'''HTTP Method''' : POST<br />
<br />
==== Parameters ==== <br />
{| border="1" cellpadding="6" style="border-collapse: collapse; margin: 10px 0; border-color: #3366CC;"<br />
|-<br />
! Parameter Name !! Type !! Required !! Description<br />
|-<br />
| login || String || Y || User login<br />
|-<br />
| passwd || String || Y || User password '''encrypted md5'''<br />
|-<br />
| volumes || Array[String] || N || Volumes list<br />
|}<br />
==== Example Webservice Call ====<br />
* PHP<br />
<span style="color:#009900">/* Set parameters to provide to getCriteres() function */</span><br />
$parameters = array(<br />
"login" => "userLogin", <span style="color:#009900"> // User login </span><br />
"passwd" => md5("userPassword"), <span style="color:#009900"> // User password encrypted md5 </span><br />
"volumes" => array( <span style="color:#009900"> // 'Volumes' list, can be defined with getVolumes() </span><br />
"Invoices",<br />
"Templates",<br />
"Others"<br />
);<br />
);<br />
<br /><br />
$aCriteria = $client -> getCriteres($parameters); <span style="color:#009900"> // $aCriteria is an array, see Example Webservice Response in this chapter for more details.</span><br />
==== Example Webservice Response ====<br />
* PHP<br />
getCriteresResult => <br />
array(<br />
Critere => <br />
array(<br />
"m_critere" => "c_date", <span style="color:#009900">// Criterion name </span><br />
"m_type" => "varchar", <span style="color:#009900">// Variable type </span><br />
"m_format" => "", <span style="color:#009900">// Value format, Ex: Azaz09 </span><br />
"m_description" => "date", <span style="color:#009900">// Criterion description </span><br />
"m_visu" => "vu", <span style="color:#009900">// Define if the criterion is hide or visible </span><br />
"m_visuSearch" => "" <span style="color:#009900">// Define if the crierion is hide or visible for a search </span><br />
);<br />
);<br />
<br />
==== Tips ====<br />
* PHP<br />
<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><br />
$aCriteriaNames = array();<br />
if(count($aCriteria->getCriteresResult->Critere) > 1) <span style="color:#009900"> // If the web service returned criterias </span><br />
{<br />
foreach($aCriteria->getCriteresResult as $criterion)<br />
{<br />
array_push($aCriteriaNames, $criterion->m_critere); <span style="color:#009900"> // For each criterion, push the name value to array $aCriteriaNames</span><br />
}<br />
}<br />
==== Error Messages ====<br />
<span style="color:#EE0000">'''Modifiable selon la gestion des erreurs'''</span><br />
{<br />
"exception": "invalid_parameter_exception",<br />
"errorcode": "invalidparameter",<br />
"message": "Invalid parameter value detected"<br />
}<br />
{{BlocEnd}}<br />
{{BlocEnd}}<br />
{{BoxEnd}}</div>
imported>Bdezeque