REST API

Aktualna dokumentacja nowoczesnego interfejsu rest api jest dostępna pod adresem https://developers.shoper.pl/

REST API - dokumentacja interfejsu























user.list

Pobiera listę użytkowników

        array call(string $session_id, "user.list", array($extended = false, $info = false, $addresses = false, $groups = false, $users = null, $additionalFields = false))
    

Parametry wejściowe

  • extended (boolean) - czy zwrócić informacje o obiektach
  • info (boolean) - jeśli $extended==true to zwróci także dodatkowe informacje o użytkowniku
  • addresses (boolean) - jeśli $extended==true to zwróci także adresy każdego z użytkowników
  • groups (boolean) - jeśli $extended==true to zwróci także grupy każdego z użytkowników
  • users (array|null) - tablica identyfikatorów obiektów do pobrania lub **null** w celu pobrania wszystkich dostępnych obiektów
  • additionalFields (boolean) - jeśli $additionalFields=true to zwróci także dodatkowe pola użytkownika

Wartość zwracana

  • tablica zawierająca identyfikatory użytkowników, chyba, że $extended==true, wtedy zwróci tablicę tablic o strukturze takiej, jak w user.info (array)

Uwagi

  • Wartości tablicy zwróconej przez tą metodę od pewnego klucza mogą przyjmować wartość array('error' ⇒ -2) - to oznacza, że skrypt po stronie serwera nie miał już czasu na wykonanie żądanych operacji na obiektach (poprzednie iteracje przekroczyły 80% całego dostępnego czasu na wykonanie skryptu). W celu zdobycia oczekiwanych informacji, należy ponowić zapytanie wysyłając tablicę pominiętych obiektów. W celu zapewnienia kompatybilności typów zwracanych obiektów kod błędu jest sygnalizowany przez tablicę asocjacyjną zawierającą klucz 'error'

Rzucane wyjątki SoapFault

  • W przypadku braku dostępu do odczytu dla modułu 'klienci', wyrzucany jest wyjątek z komunikatem **Access denied**

Uwagi

  • Istnieje możliwość wystąpienia wyjątku SoapFault w przypadku nieprawidłowego działania modułu aplikacji. (np poprzez modyfikację kodu aplikacji lub poprzez nieoczekiwany błąd po stronie serwera)