Matchmaking - List Server Backfill Tickets For Player

List all server backfill ticket Ids the user is a member of.

POST https://titleId.playfabapi.com/Match/ListServerBackfillTicketsForPlayer

Request Body

Name Required Type Description
Entity True

The entity key for which to find the ticket Ids.

QueueName True
  • string

The name of the queue the tickets are in.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

EntityToken

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

EntityKey

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

ListServerBackfillTicketsForPlayerRequest

List all server backfill ticket Ids the user is a member of.

ListServerBackfillTicketsForPlayerResult

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

ListServerBackfillTicketsForPlayerRequest

List all server backfill ticket Ids the user is a member of.

Name Type Description
Entity

The entity key for which to find the ticket Ids.

QueueName
  • string

The name of the queue the tickets are in.

ListServerBackfillTicketsForPlayerResult

Name Type Description
TicketIds
  • string[]

The list of backfill ticket Ids the user is a member of.

Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingRateLimitExceeded 2054
MatchmakingUnauthorized 2056