Groups - List Group Blocks

Service:

Groups

API Version:

240412

Lists all entities blocked from joining a group

POST https://titleId.playfabapi.com/Group/ListGroupBlocks

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
Group	True	EntityKey	The identifier of the group
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	ListGroupBlocksResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
EntityWithLineage	Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.
GroupBlock	Describes an entity that is blocked from joining a group.
ListGroupBlocksRequest	Lists all entities blocked from joining a group. A list of blocked entities is returned
ListGroupBlocksResponse

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

EntityWithLineage

Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.

Name	Type	Description
Key	EntityKey	The entity key for the specified entity
Lineage	EntityKey	Dictionary of entity keys for related entities. Dictionary key is entity type.

GroupBlock

Describes an entity that is blocked from joining a group.

Name	Type	Description
Entity	EntityWithLineage	The entity that is blocked
Group	EntityKey	ID of the group that the entity is blocked from

ListGroupBlocksRequest

Lists all entities blocked from joining a group. A list of blocked entities is returned

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Group	EntityKey	The identifier of the group

ListGroupBlocksResponse

Name	Type	Description
BlockedEntities	GroupBlock[]	The requested list blocked entities.