Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetSellFormFieldsExtLimit

Ostatnia zmiana: 26.05.2011 r.
Dostępność:
Metoda pozwala na pobranie w porcjach listy pól formularza sprzedaży dostępnych we wskazanym kraju. Wybrane pola mogą następnie posłużyć np. do zbudowania i wypełnienia formularza wystawienia nowej oferty z poziomu metody doNewAuctionExt. Domyślnie zwracanych jest 50 pierwszych pól. Rozmiar porcji pozwala regulować parametr package-element, a sterowanie pobieraniem kolejnych porcji danych umożliwia parametr offset.

  1. country-code | int | wymagany
    Identyfikator kraju (listę identyfikatorów krajów uzyskać można za pomocą metody doGetCountries).
  2. local-version | long | niewymagany
    Parametr zdezaktualizowany (należy przekazać dowolną wartość, odpowiednią dla typu parametru).
  3. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.
  4. offset | int | niewymagany
    Parametr pozwalający na sterowanie pobieraniem kolejnych porcji danych (numery porcji indeksowane są od 0).
  5. package-element | int | niewymagany
    Parametr pozwalający na określenie rozmiaru porcji danych (min. 1, domyślnie 50).



Orientacyjna struktura wywołania metody

$dogetsellformfieldsextlimit_request = array(
   'country-code' => 1,
   'local-version' => 0,
   'webapi-key' => 'g2fe408289',
   'offset' => '5',
   'package-element' => '2'
);

  1. sell-form-fields | SellFormType[]
    Tablica struktur zawierających informacje o polach formularza sprzedaży.
    1. sell-form-id | int
      Identyfikator pola.
    2. sell-form-title | string
      Nazwa pola.
    3. sell-form-cat | int
      Identyfikator kategorii, do której odnosi się pole (dotyczy też wszystkich podkategorii wskazanej kategorii). 0 oznacza, że parametr odnosi się do wszystkich kategorii.
    4. sell-form-type | int
      Określenie typu pola w formularzu sprzedaży (1 - string, 2 - integer, 3 - float, 4 - combobox, 5 - radiobutton, 6 - checkbox, 7 - image (base64Binary), 8 - text (textarea), 9 - datetime (Unix time)).
    5. sell-form-res-type | int
      Wskazanie na typ pola, w którym należy przekazać wybraną wartość pola (1 - string, 2 - integer, 3 - float, 7 - image (base64Binary), 9 - datetime (Unix time)).
    6. sell-form-def-value | int
      Domyślna wartość pola (dla pól typu combobox/radiobutton/checkbox - na podstawie sell-form-opts-values).
    7. sell-form-opt | int
      Informacja na temat obligatoryjności pola (1 - pole obowiązkowe, 8 - pole opcjonalne).
    8. sell-form-pos | int
      Pozycja pola na liście pól w formularzu sprzedaży. 0 oznacza, że stosowane jest sortowanie alfabetyczne.
    9. sell-form-length | int
      Dopuszczalny rozmiar (w znakach) przekazywanej wartości pola.
    10. sell-min-value | float
      Minimalna możliwa do przekazania wartość pola (dot. pól typu: int, float, combobox, checkbox, date; wartość 0 wskazuje na brak dolnego ograniczenia).
    11. sell-max-value | float
      Maksymalna możliwa do przekazania wartość pola (dot. pól typu: int, float, combobox, checkbox, date; wartość 0 wskazuje na brak górnego ograniczenia).
    12. sell-form-desc | string
      Opis kolejnych wartości, które można ustawić dla pola (dot. pól typu combobox/radiobutton/checkbox).
    13. sell-form-opts-values | string
      Wskazanie konkretnych wartości (odpowiednich dla opisów wyżej), które można ustawić dla danego pola (dot. pól typu combobox/radiobutton/checkbox, dla pól typu checkbox kolejne wartości można sumować).
    14. sell-form-field-desc | string
      Szczegółowy opis pola.
    15. sell-form-param-id | int
      Unikalny identyfikator pola.
    16. sell-form-param-values | string
      Unikalne i niezmienne identyfikatory wartości parametru (dot. pól typu combobox/radiobutton/checkbox).
    17. sell-form-parent-id |int
      Identyfikator parametru rodzica (jego sell-form-param-id - tylko dla parametrów zależnych nie będących na szczycie hierarchi. Jeżeli dany parametr nie jest parametrem zależnym, lub jeżeli znajduje się na szczycie hierarchi parametrów zależnych - w polu zwracana zostanie wartość 0).
    18. sell-form-parent-value | string
      Wartość parametru rodzica, dla której parametr powiązany może być wykorzystany (tylko dla parametrów zależnych. Jeżeli dany parametr nie jest parametrem zależnym - w polu nie zostanie zwrócona żadna wartość).
    19. sell-form-unit | string
      Jednostka parametru (jeżeli została określona).
    20. sell-form-options | int
      Dodatkowe własności parametru: 1 - parametr zależny; 2 - parametr typu checkbox z wykorzystaniem operatora OR (z możliwym wyborem jednej lub wielu wartości), w przypadku gdy ta wartość nie jest ustawiona działanie parametru opiera się na operatorze AND; 6 - parametr typu checkbox z możliwym wyborem pojedynczej wartości (w praktyce combobox); 8 - parametr zakresowy.
  2. ver-key | long
    Wartość klucza wersji odpowiednia dla wybranego kraju i przekazanego klucza WebAPI.
  3. ver-str | string
    Wersja komponentu pól formularza sprzedaży odpowiednia dla przekazanego klucza WebAPI.
  4. form-fields-count | int
    Liczba wszystkich pól formularza sprzedaży.



Orientacyjna struktura odpowiedzi serwera

$dogetsellformfieldsextlimit_response = array(
   'sell-form-fields' => array(
      array(
         'sell-form-id' => 11,
         'sell-form-title' => 'Miejscowość',
         'sell-form-cat' => 0,
         'sell-form-type' => 1,
         'sell-form-res-type' => 1,
         'sell-form-def-value' => 0,
         'sell-form-opt' => 1,
         'sell-form-pos' => 11,
         'sell-form-length' => 100,
         'sell-min-value' => 0.00,
         'sell-max-value' => 0.00,
         'sell-form-desc' => '',
         'sell-form-opts-values' => '',
         'sell-form-field-desc' => 'Wpisz miejscowość',
         'sell-form-param-id' => 0,
         'sell-form-param-values' => '',
         'sell-form-parent-id' => 0,
         'sell-form-parent-value' => '',
         'sell-form-unit' => '',
         'sell-form-options' => 0),
      array(
         'sell-form-id' => 12,
         'sell-form-title' => 'Transport',
         'sell-form-cat' => 0,
         'sell-form-type' => 5,
         'sell-form-res-type' => 2,
         'sell-form-def-value' => 1,
         'sell-form-opt' => 1,
         'sell-form-pos' => 12,
         'sell-form-length' => 1,
         'sell-min-value' => 0.00,
         'sell-max-value' => 1.00,
         'sell-form-desc' => 'Sprzedający pokrywa koszty transportu|Kupujący pokrywa koszty transportu',
         'sell-form-opts-values' => '0|1',
         'sell-form-field-desc' => 'Proszę dokonać wyboru, która ze stron, biorących udział w licytacji, pokryje wszelkie koszty związane z transportem sprzedanego przedmiotu',
         'sell-form-param-id' => 0,

         'sell-form-param-values' => '',
         'sell-form-parent-id' => 0,
         'sell-form-parent-value' => '',
         'sell-form-unit' => '',
         'sell-form-options' => 0)),
   'ver-key' => 16551276,
   'ver-str' => '1.0.56',
   'form-fields-count' => 2750
);

  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • ERR_NO_DATABASE
    Problemy z bazą danych Allegro.
  • ERR_WEBAPI_EXPIRED
    Data ważności klucza WebAPI została przekroczona.
  • ERR_WEBAPI_KEY
    Niepoprawna wartość klucza WebAPI lub klucz został zablokowany.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI został zdezaktywowany (nie zaakceptowano warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.

Allegro nie bierze odpowiedzialności za skutki wykorzystania zamieszczonych przykładów kodu, nie daje także gwarancji ich poprawnego działania. Widoczny kod ma charakter wyłącznie poglądowy i może zawierać błędy.