Allegro WebAPI

Programming interface of the Allegro platform

doGetBlackListUsers

Group: Blacklist
Last change: ---
Availability:
This method allows for loading a list of users added to blacklists by the logged-in user.

  1. session-handle | string | required
    User's session identifier received using the doLogin(Enc) method.



Sample structure of method call

$dogetblacklistusers_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1'
);

  1. black-list-users | BlackListStruct[]
    Array of structures containing information on users added to the blacklist.
    1. user-id | long
      User identifier.
    2. user-login | string
      Username.
    3. user-rating | int
      User's score.
    4. user-country | int
      User's country.



Sample structure of server reply

$dogetblacklistusers_response = array(
   'black-list-users' => array(
      array(
         'user-id' => 6241878,
         'user-login' => 'i_like_cheese',
         'user-rating' => 0,
         'user-country' => 1),
      array(
         'user-id' => 7730309,
         'user-login' => 'i_like_coffee',
         'user-rating' => 0,
         'user-country' => 1))
);

  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Invalid session identifier or the session has expired.
  • ERR_WEBAPI_KEY_INACTIVE
    The session-generating WebAPI key has been deactivated (the owner did not accept the User Agreement).
  • ERR_WEBAPI_NOT_AVAIL
    Problems with Allegro WebAPI service.

Allegro is not to be held liable for consequences of using examples of the published code. It does not guarantee its correct operation either. The code you see serves as an example only and may contain errors.