Documentation

CancelServerBackfillTicket

Cancel a server backfill ticket.

Attention, this is a flagged API

Beta
This API is under development; Please let us know if you find any bugs or inconsistencies. Also note, that minor changes may occur before this API leaves beta.

Please let us know if you find any issues or inconsistencies.

Request Details

Only servers can cancel a backfill ticket. The ticket can be in three different states when it is cancelled. 1: the ticket is matching. If the ticket is cancelled, it will stop matching. 2: the ticket is matched. A matched ticket cannot be cancelled. 3: the ticket is already cancelled and nothing happens. There may be race conditions between the ticket getting matched and the server making a cancellation request. The server must handle the possibility that the cancel request fails if a match is found before the cancellation request is processed. We do not allow resubmitting a cancelled ticket. Create a new ticket instead.

CancelServerBackfillTicketRequest
Request Properties
QueueName (required) String

The name of the queue the ticket is in.

TicketId (required) String

The Id of the ticket to find a match for.

POST https://{{TitleID}}.playfabapi.com/Match/CancelServerBackfillTicket
    Content-Type: application/json
{
  "TicketId": "1c4b0daa-150e-47ae-9923-d770c0f9b07c",
  "QueueName": "custom123"
}
        

Response Details

CancelServerBackfillTicketResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {}
}

Authentication

EntityToken

Possible Error Codes

Name Code
MatchmakingEntityInvalid 2001
MatchmakingQueueNotFound 2016
MatchmakingTicketAlreadyCompleted 2029
MatchmakingTicketNotFound 2018
MatchmakingUnauthorized 2056