@extends('documentation.webservice.squelette')
<!-- ************************************** -->
@section('titre')
{{ __("Généralités") }}
@endsection

@section('menu')
    {{-- <li class="nav-item">
        <a class="nav-link scrollto" href="#app-components">Généralités</a>
    </li> --}}
    <li class="nav-item">
        <ul class="nav doc-sub-menu nav flex-column">
            <li class="nav-item">
                <a class="nav-link scrollto" href="#fonctionnement">Fonctionnement</a>
            </li>
            <li class="nav-item">
                <a class="nav-link scrollto" href="#appels_get">Appels get</a>
            </li>
            <li class="nav-item">
                <a class="nav-link scrollto" href="#filtrage">Filtrage des résultats</a>
            </li>

            <li class="nav-item">
                <a class="nav-link scrollto" href="#jeu">Jeu de résultats</a>
            </li>
            <li class="nav-item">
                <a class="nav-link scrollto" href="#tri">Tri des résultats</a>
            </li>
        </ul><!--//nav-->
    </li>
@endsection

@section('contenu')

        <section id="fonctionnement" class="doc-section">
            <h2 class="section-title">Fonctionnement</h2>
            <div class="section-block">
                <p>
                    Le web service ELAN Providers fonctionne en mode REST. <br>


                    REST API (Representational State Transfer Application Program Interface) est un style architectural qui permet aux logiciels de
                    communiquer entre eux sur un réseau ou sur un même appareil.
                    <br>
                    Souvent appelés services web RESTful, REST utilise des méthodes HTTP pour récupérer et publier des données entre
                    un périphérique client et un serveur.

                    <br><br>
                    On accède à une ressource (par son URL unique) pour procéder à diverses opérations
                    (GET lecture / POST écriture / PUT modification / DELETE suppression), opérations supportées nativement par http :

                    • lecture : Requête de type GET
                    • écriture (insertion/modification) : Requête de type POST
                    • Suppression: Requête de type DELETE

                    Les échanges se font obligatoirement au format JSON.
                    <br><br>
                    <b>NB : le web service permet uniquement des appels de type GET (consultation) et POST (insertion). </b>
                </p>
            </div>
        </section><!--//doc-section-->
        <section id="appels_get" class="doc-section">
            <h2 class="section-title">Appels standard en GET</h2>
            <br><br>
            En appel de type GET, le webservice va renvoyer les codes suivants.
            <br><br>
            <h6>Liste des codes retour possibles</h6>
                <div class="table-responsive">
                    <table class="table table-bordered">
                        <thead>
                            <tr>
                                <th>Code</th>
                                <th>Description</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr>
                                <td>200</td>
                                <td>Statut HTTP 200 OK, retourne le résultat au format JSON</td>
                            </tr>
                            <tr>
                                <td>204</td>
                                <td>Statut HTTP 204 NO CONTENT si pas de résultats</td>
                            </tr>
                            <tr>
                                <td>500</td>
                                <td>Service indisponible</td>
                            </tr>
                        </tbody>
                    </table>
                </div><!--//table-responsive-->

            <div id="filtrage"  class="section-block">
                <h3 class="block-title">Filtrage des résultats sur les listes</h3>
                <br>
                Lors des appels effectués sur les listes de résultats (ex : .../interventions, ou ..../sites) les résultats peuvent être filtrés comme des requêtes SQL.
                <br> Pour cela, vous pouvez utiliser le paramètre "filter". Il s'agit de trois paramètres séparés par des virgules.<br><br>

                <table class="table table-bordered">
                    <thead>
                        <tr>
                            <th>Paramètre</th>
                            <th>Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr>
                            <td>1</td>
                            <td>Champ à filtrer</td>
                        </tr>
                        <tr>
                            <td>2</td>
                            <td>Type de filtre</td>
                        </tr>
                        <tr>
                            <td>3</td>
                            <td>Valeur</td>
                        </tr>
                    </tbody>
                </table>


                Exemple :
                <p><code>filter=int_number,sw,23010010</code></p>

                <br>
                <b>Valeurs possibles des types de filtres:</b><br><br>
                <div class="table-responsive">
                    <table class="table table-bordered">
                        <thead>
                            <tr>
                                <th>Valeur</th>
                                <th>Description</th>
                            </tr>
                        </thead>
                        <tbody>
                            <tr> <td>cs</td> <td>contain string (contient)</td> </tr>
                            <tr> <td>sw</td> <td>start with (string commence par)</td> </tr>
                            <tr> <td>ew</td> <td>end with (string finit par)</td> </tr>
                            <tr> <td>eq</td> <td>equal (est égal à)</td> </tr>
                            <tr> <td>ne</td> <td>not equal (est différent de)</td> </tr>
                            <tr> <td>lt</td> <td>lower than (inférieur)</td> </tr>
                            <tr> <td>le</td> <td>lower or equal (inférieur ou égal)</td> </tr>
                            <tr> <td>ge</td> <td>greater or equal (supérieur ou égal)</td> </tr>
                            <tr> <td>gt</td> <td>greater than (supérieur)</td> </tr>
                            <tr> <td>in</td> <td>in (in (separateur=.))/td> </tr>
                        </tbody>
                    </table>
                </div><!--//table-responsive-->

                Paramètres filter : 3 paramètres séparés par des virgules <br>

                <br><br>
                <b>NB : Vous pouvez appliquer plusieurs filtres en les séparant par le caractère '|' </b><br>
                Exemple :
                <p><code>https://.../interventions?filter=int_number,sw,23010010|int_title,cs,elec</code></p>
                Renvoie toutes les interventions dont le n° est plus petit que 23010010 et dont le titre contient “elec” <br>
                <br>

            </div><!--//section-block-->


            <div id="jeu"  class="section-block">
                <h3 class="block-title">Jeu de résultats</h3>
                <p>Lors des appels effectués sur les listes de résultats (ex : .../interventions, ou ..../sites) , vous pouvez spécifier la liste des colonnes à renvoyer dans le résultat, séparées par des virgules grâce à l'option "columns"".</p>

                Exemple :
                <p><code>https://.../interventions?columns=int_number,int_title</code></p>
            </div><!--//section-block-->

            <div id="tri"  class="section-block">
                <h3 class="block-title">Tri des résultats</h3>
                <p>Vous pouvez trier les données dans le fichier JSON de retour grâce à l'option ORDER.
                    Cette dernière prend deux paramètres en entrée, le champ et le sens de tri.</p>

                Exemple :
                <p><code>http://....../interventions?order=int_number,desc</code></p>

            </div><!--//section-block-->
        </section><!--//doc-section-->

@endsection