Player Item Management - Get Random Result Tables
Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights
POST https://titleId.playfabapi.com/Server/GetRandomResultTables
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-SecretKey | True |
|
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
TableIDs | True |
|
The unique identifier of the Random Result Table to use. |
CatalogVersion |
|
Specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses default/primary catalog. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Note that if a specified Random Result Table contains no entries, or does not exist in the catalog, 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
Api |
The basic wrapper around every failed API response |
Get |
|
Get |
Note that if a specified Random Result Table contains no entries, or does not exist in the catalog, an InvalidDropTable error will be returned. |
Random |
|
Result |
|
Result |
ApiErrorWrapper
The basic wrapper around every failed API response
Name | Type | Description |
---|---|---|
code |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
GetRandomResultTablesRequest
Name | Type | Description |
---|---|---|
CatalogVersion |
|
Specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses default/primary catalog. |
TableIDs |
|
The unique identifier of the Random Result Table to use. |
GetRandomResultTablesResult
Note that if a specified Random Result Table contains no entries, or does not exist in the catalog, an InvalidDropTable error will be returned.
Name | Type | Description |
---|---|---|
Tables |
array of random result tables currently available |
RandomResultTableListing
Name | Type | Description |
---|---|---|
CatalogVersion |
|
Catalog version this table is associated with |
Nodes |
Child nodes that indicate what kind of drop table item this actually is. |
|
TableId |
|
Unique name for this drop table |
ResultTableNode
Name | Type | Description |
---|---|---|
ResultItem |
|
Either an ItemId, or the TableId of another random result table |
ResultItemType |
Whether this entry in the table is an item or a link to another table |
|
Weight |
|
How likely this is to be rolled - larger numbers add more weight |
ResultTableNodeType
Name | Type | Description |
---|---|---|
ItemId |
|
|
TableId |
|
Error Codes
Name | Code |
---|---|
CatalogNotConfigured | 1218 |
InvalidDropTable | 1201 |