FamilleService :: GetList

The POST method, is used to retrieve data.

The list of parameters is not mandatory to request:

  • Criteria criteria,
  • array orders,
  • int pageNumber,
  • int rowsPerPage.

Returns data as JSON, for use in PHP, you need to convert JSON in StdClass PHP (PHP function: json_decode ()).

Input parameters:

  • Criteria
{"criteria":  
 {
  "__type":"CriteriaLogical:http://www.proconsult.lu/WebServices100",
  "Operand1": 
  {
   "__type":"CriteriaComparison:http://www.proconsult.lu/WebServices100",
   "FieldName": "TypeFamille",
   "Operator": "0",
   "Value": 0
  },
  "Operator":0
 }
}
  • orders
{"orders":[{"CodeFamille":"Asc"}]}
  • pageNumber
{pageNumber: 1}
  • rowsPerPage
{rowsPerPage: 10}

Example:

require (__DIR__ . '/service/Criteria.php');

use services\WebServices100;

// add parameters
$data = new stdClass();
$data->criteria = null;
$data->orders = [];
$data->orders[]->CodeFamille = 'Asc';

$json_data = json_encode($data);

$url = 'http://<Your ip>:<Your Port>/WebServices100/<Your environment>/FamilleService/rest/GetList';

// Send requests to receive data
$result = WebServices100::getData($url, $json_data);

$response= json_decode($result);

Result:

Array
(
    [0] => stdClass Object
        (
            [CodeFamille] => AR
            [Intitule] => Articles en Argent & métaux divers
            [TypeFamille] => 2
        )

    [1] => stdClass Object
        (
            [CodeFamille] => BIJOUXARG
            [Intitule] => Bijouterie Argent
            [TypeFamille] => 0
        )

    [2] => stdClass Object
        (
            [CodeFamille] => OR
            [Intitule] => Articles en Or
            [TypeFamille] => 2
        )

    [3] => stdClass Object
        (
            [CodeFamille] => BIJOUXOR
            [Intitule] => Bijouterie Or
            [TypeFamille] => 0
        )
)