Allegro WebAPI

Interfejs programistyczny platformy Allegro

doAddToBlackList

Tematyka: Czarna lista
Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na dodanie wskazanych użytkowników do czarnej listy zalogowanego użytkownika. Użytkownicy dodani do czarnej listy nie mogą kupować żadnych przedmiotów od użytkownika, na którego czarnej liście się znajdują.

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. users-black-list-array | UserBlackListStruct[] | wymagany
    Tablica struktur zawierających informacje o użytkownikach, którzy mają zostać dodani do czarnej listy (maks. 25).
    1. user-id | int | wymagany
      Identyfikator użytkownika.
    2. user-black-list-note | string | niewymagany
      Notatka opisująca powód dodania użytkownika do czarnej listy.



Orientacyjna struktura wywołania metody

$doaddtoblacklist_request = array(
   'session-handle
' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
  
'users-black-list-array' => array(
      array(
        
'user-id' => 6241878,
        
'user-black-list-note' = 'Żartowniś'),
      array(
        
'user-id' => 7730309,
         'user-black-list-note' = ''))
);

  1. user-black-list-results-arr | UserBlackListAddResultStruct[]
    Tablica struktur zawierających informacje o wynikach operacji.
    1. user-id | int
      Identyfikator użytkownika.
    2. add-to-black-list-result | int
      Wynik próby dodania użytkownika do czarnej listy (1 - pozytywny, 0 - negatywny).
    3. add-to-black-list-err-code | string
      Kod błędu wskazujący na powód niepowodzenia (dla wyniku negatywnego).
    4. add-to-black-list-err-msg | string
      Komunikat błędu opisujący powód niepowodzenia (dla wyniku negatywnego).



Orientacyjna struktura odpowiedzi serwera

$doaddtoblacklist_response = array(
   'user-black-list-results-arr
' => array(
      array(
        
'user-id' => 6241878,
         'add-to-black-list-result' => 1,
         'add-to-black-err-code' => '',
         'add-to-black-err-msg' => ''),
      array(
         'user-id' => 7730309,
         'add-to-black-list-result' => 0,
         'add-to-black-err-code' => 'ERR_USER_ALREADY_ADDED_TO_BLACK_LIST',
         'add-to-black-err-msg' => 'Ten Użytkownik już jest na Twojej czarnej liście'))
);


  • ERR_CANT_ADD_YOURSELF_TO_BLACK_LIST
    Nie można dodać siebie samego do czarnej listy.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_USER_ALREADY_ADDED_TO_BLACK_LIST
    Wskazany użytkownik znajduje się już na czarnej liście.
  • ERR_USER_IS_GUEST
    Wskazany użytkownik nie ma zarejestrowanego konta w serwisie.
  • ERR_USER_NOT_FOUND
    Niepoprawny identyfikator użytkownika
  • ERR_USERS_ARRAY_OVERSIZED
    Nie podano żadnego identyfikatora użytkownika lub liczba podanych identyfikatorów przekracza dopuszczalny limit (maks. 25).
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował 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.