Metoda attribute.list
Pobiera informacje o liście atrybutów
array call(string $session_id, "attribute.list", array($extended = false, $attributes = ""))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- extended (boolean) - czy zwrócić tylko listę identyfikatorów (false), czy tablicę, której wartościami są tablice asocjacyjne informacji o żądanych obiektach (true)
- attributes (array|null) - tablica identyfikatorów obiektów do pobrania lub null w celu pobrania wszystkich dostępnych obiektów
Wartość zwracana
- (array) - $data jeśli parametr extended ustawiony jest na false, zwracana jest tablica z identyfikatorami dostępnych obiektów
- (array) - $data jeśli parametr extended ustawiony jest na true, zwracana jest tablica, która składa się z tablic asocjacyjnych o strukturze:
- ['attribute_id'] (int) - identyfikator atrybutu
- ['name'] (string) - nazwa atrybutu
- ['description'] (string) - opis atrybutu
- ['pres_id'] (int) - identyfikator grupy atrybutów
- ['order'] (int) - priorytet wyświetlania atrybutu
- ['type'] (int[0/1/2]) - typ atrybutu: 0 - pole tekstowe, 1 - pole checkbox, 2 - pole select
- ['active'] (int[0/1]) - aktywność atrybutu
- ['default'] (string) - wartość domyślna atrybutu (w przypadku atrybutu typu checkbox, wartość 0 lub 1)
- ['options'] (array) - tablica dostępnych opcji dla atrybutu typu select, której wartościami są nazwy dostępnych opcji
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 podania identyfikatora nieistniejącego obiektu, rzucany jest wyjątek
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, "attribute.list", Array(true, // extended Array(1, 2, 3) // id atrybutów ) ) ); // 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) { $attribute = (Array)$item; echo "Id atrybutu: " . $attribute['attribute_id'] . "<br>"; echo "Nazwa atrybutu: " . $attribute['name'] . "<br>"; if ($attribute['type'] == 2) { // jeśli typ select echo "Opcje:<br>"; $options = (Array)$attribute['options']; foreach ($options as $opt) { echo "Wartość: " . $opt . "<br>"; } } echo "<hr><br>"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>