Strict Standards: Declaration of action_plugin_searchtext::register() should be compatible with DokuWiki_Action_Plugin::register($controller) in /lib/plugins/searchtext/action.php on line 14

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/auth.php on line 313

Warning: Cannot modify header information - headers already sent by (output started at /lib/plugins/searchtext/action.php:14) in /inc/actions.php on line 163
webapi:currency.list [Shop Docs]

Dokumentacja techniczna

Metoda currency.list

Pobiera listę walut

array call(string $session_id, "currency.list", array($extended = false, $currencies = ""))
Ta metoda wywoływana jest za pośrednictwem metody call

Parametry wejściowe

  1. extended (bool) - - czy zwrócić tylko listę identyfikatorów walut (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
  2. currencies

Wartość zwracana

  1. (array) - jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów.
  2. (array) - jeśli parametr extended ustawiony jest na true, zwracana jest tablica (wektor) o długości tablicy podanej jako drugi parametr metody. Wektor składa się z tablic asocjacyjnych o strukturze:
    • ['currency_id'] (int) - identyfikator waluty
    • ['name'] (string) - kod waluty w formacie ISO 4217
    • ['rate'] (double) - kurs waluty względem waluty domyślnej. Waluta domyślna posiada kurs o wartości 1.
    • ['active'] (int[0/1]) - aktywność waluty
    • ['order'] (int) - kolejność waluty
    • ['default'] (int[0/1]) - waluta domyślna
    • ['rate_sync'] (double) - kurs waluty po synchronizacji z NBP
    • ['rate_date'] (string) - data synchronizacji z NBP w formacie ISO 8601
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 próby pobrania informacji o nieistniejącej walucie, rzucany jest wyjątek z komunikatem Currency identified as id: {$id} does not exist
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)

Przykład wywołania w PHP

<?php
 
/**
 * Logowanie do API
 * 
 * @param resource $c cURL resource handle
 * @param string $login Login użytkownika
 * @param string $password Hasło użytkownika
 * @return string Indentyfikatorr sesji użytkownika
 */
function login($c, $login, $password) {
    $params = Array(
        "method" => "login",
        "params" => Array($login, $password)
    );
    curl_setopt($c, CURLOPT_POSTFIELDS, "json=" . json_encode($params));
    $result = (Array) json_decode(curl_exec($c));
    if (isset($result['error'])) {
        return null;
    } else {
        return $result[0];
    }
}
 
$c = curl_init();
curl_setopt($c, CURLOPT_URL, 'http://shop.example.com/webapi/json/');
curl_setopt($c, CURLOPT_POST, true);
curl_setopt($c, CURLOPT_RETURNTRANSFER, 1);
 
// zalogowanie użytkownika i pobranie identyfikatora sesji
$session = login($c, "api", "test");
 
if ($session != null) {
    $params = Array(
        "method" => "call",
        "params" => Array($session, "currency.list", 
                Array(true, //extended
                        Array(1, 2, 3) // id walut
                    )
            )
    );
 
    // zakodowanie parametrów dla metody POST
    $postParams = "json=" . json_encode($params);
    curl_setopt($c, CURLOPT_POSTFIELDS, $postParams);
 
    // dekodowanie rezultatu w formacie JSON do tablicy result
    $data = curl_exec($c);
    $result = (Array)json_decode($data);
 
    // sprawdzenie, czy wystąpił błąd
    if (isset($result['error'])) {
        echo "Wystąpił błąd: " . $result['error'] . ", kod: " . $result['code'];
    } else {
        foreach ($result as $item) {
            $currency = (Array)$item;
 
            echo "Id: " . $currency['currency_id'] . "<br>";
            echo "Kod waluty: " . $currency['name'] . "<br>";
            echo "Kurs: " . $currency['rate'] . "<br>";
 
            echo "<hr><br>";
        }
    }
} else {
    echo "Wystąpił błąd logowania";
}
 
curl_close($c);
?>