Player Item Management - Evaluate Random Result Table

Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.

POST https://titleId.playfabapi.com/Server/EvaluateRandomResultTable

Request Header

Name Required Type Description
X-SecretKey True
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
TableId True
  • string

The unique identifier of the Random Result Table to use.

CatalogVersion
  • string

Specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses default/primary catalog.

Responses

Name Type Description
200 OK

Note that if the Random Result Table contains no entries, or does not exist for the catalog specified (the Primary catalog if one is not specified), an InvalidDropTable error will be returned.

400 Bad Request

This is the outer wrapper for all responses with errors

Security

X-SecretKey

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

EvaluateRandomResultTableRequest
EvaluateRandomResultTableResult

Note that if the Random Result Table contains no entries, or does not exist for the catalog specified (the Primary catalog if one is not specified), an InvalidDropTable error will be returned.

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

EvaluateRandomResultTableRequest

Name Type Description
CatalogVersion
  • string

Specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses default/primary catalog.

TableId
  • string

The unique identifier of the Random Result Table to use.

EvaluateRandomResultTableResult

Note that if the Random Result Table contains no entries, or does not exist for the catalog specified (the Primary catalog if one is not specified), an InvalidDropTable error will be returned.

Name Type Description
ResultItemId
  • string

Unique identifier for the item returned from the Random Result Table evaluation, for the given catalog.

Error Codes

Name Code
CatalogNotConfigured 1218
InvalidDropTable 1201