Get Blocked List For Player V2

GET 
/friends/v2/player/:player_uuid/block

Fetch the blocked list for the Player.

Note: This API supports etags and will return the etag header when with the response.

Clients can utilize the if-none-match header to avoid having to reload the response if it has not changed.

Permissions Required: friend:block_list:read

Request

Path Parameters

player_uuid uuidrequired

Query Parameters

page Page

Default value: 0

limit Limit

Possible values: >= 1 and <= 10000

Default value: 50

Header Parameters

if-none-match If-None-Match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be return - indicating that the resource has not changed.

Responses

200

Successful Response

Response Headers

• ETag

  string

  Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

application/json

Schema

Schema

player_uuid uuidrequired

blocked

object[]

required

Array [

blocked_player_uuid uuidrequired

last_modified_on date-timerequired

]

page

object

required

page Requested page (integer)required

limit Page size (integer)required

total Total collection size (integer)required

Example (from schema)

{
  "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "blocked": [
    {
      "blocked_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "last_modified_on": "2024-07-29T15:51:28.071Z"
    }
  ],
  "page": {
    "page": 0,
    "limit": 0,
    "total": 0
  }
}

304

Content still has the same etag and has not changed

400

Bad Request

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

409

Conflict

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...