Allegro WebAPI

Programming interface of the Allegro platform

doRemoveFromBlackList

Group: Blacklist
Last change: ---
Availability:
This method allows for removing indicated users from blacklist of a logged-in user.

  1. session-handle | string | required
    User's session identifier received using the doLogin(Enc) method.
  2. users-id-array | long[] | required
    Array of user identifiers (max. 25).



    Sample structure of method call

    $doremovefromblacklist_request = array(
       'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
       'users-id-array' => array(6241878, 9517682)
    );


    1. black-list-result | BlackListResStruct[]
      Array of structures containing information on operation results.
      1. user-id | long
        User identifier.
      2. result | int
        Result of an attempt of removing a user from a black list (1 - positive, 0 - negative).



    Sample structure of server reply

    $doremovefromblacklist_response = array(
       'black-list-result' => array(
          array(
             'user-id' => 6241878,
             'result' => 1),
          array(
             'user-id' => 9517682,
             'result' => 0))
    );


    • ERR_BLOCKED_USER_CANT_INVOKE_METHOD
      User whose account has been blocked cannot use this method.
    • ERR_NO_SESSION / ERR_SESSION_EXPIRED
      Invalid session identifier or the session has expired.
    • ERR_USERS_ARRAY_OVERSIZED
      The number of user identifiers exceeds the acceptable limit (max. 25).
    • 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.