Metoda attribute.save
Modyfikuje atrybut
array call(string $session_id, "attribute.save", array($id, $data, $force = false))
Ta metoda wywoływana jest za pośrednictwem metody call
Parametry wejściowe
- id (int) - identyfikator obiektu
- data (array) - tablica asocjacyjna z danymi obiektu o strukturze:
- ['name'] (string) - nazwa atrybutu
- ['description'] (string) - opis atrybutu
- ['order'] (int) - priorytet wyświetlania atrybutu
- ['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
- force (boolean) - czy wymusić modyfikację obiektu mimo istniejącej blokady innego administratora
Wartość zwracana
- (int) - status operacji:
- 0 - operacja się nie udała
- 1 - operacja się udała
- 2 - operacja się nie udała - obiekt jest zablokowany przez innego administratora
- -1 - podane dane są nieprawidłowe i nie spełniają wymagań walidacji
Rzucane wyjątki SoapFault
- W przypadku nie podania danych w formie tablicy, 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) { $attribute = Array( "name" => "Test aktualizacji atrybutu", // można dodać inne pola ); $params = Array( "method" => "call", "params" => Array($session, "attribute.save", Array(1, $attribute, true)) // id atrybutu, dane, force ); // 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 { if ($result[0] == -1) { echo "Podane dane są nieprawidłowe i nie spełniają wymagań walidacji"; } else if ($result[0] == 0) { echo "Operacja się nie udała"; } else if ($result[0] == 1) { echo "Operacja się udała"; } else if ($result[0] == 2) { echo "Operacja się nie udała - obiekt jest zablokowany przez innego administratora"; } } } else { echo "Wystąpił błąd logowania"; } curl_close($c); ?>