Character Data - Get Character Data
Retrieves the title-specific custom data for the character which is readable and writable by the client
POST https://titleId.playfabapi.com/Client/GetCharacterDataRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| CharacterId | True |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| IfChangedFromDataVersion |
number |
The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this. |
|
| Keys |
string[] |
Specific keys to search for in the custom user data. |
|
| PlayFabId |
string |
Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
Data is stored as JSON key-value pairs. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom character data will be returned. |
|
Get |
|
|
User |
Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned. |
|
User |
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 |
GetCharacterDataRequest
Data is stored as JSON key-value pairs. If the Keys parameter is provided, the data object returned will only contain the data specific to the indicated Keys. Otherwise, the full set of custom character data will be returned.
| Name | Type | Description |
|---|---|---|
| CharacterId |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| IfChangedFromDataVersion |
number |
The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this. |
| Keys |
string[] |
Specific keys to search for in the custom user data. |
| PlayFabId |
string |
Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. |
GetCharacterDataResult
| Name | Type | Description |
|---|---|---|
| CharacterId |
string |
Unique PlayFab assigned ID for a specific character owned by a user |
| Data |
User specific data for this title. |
|
| DataVersion |
number |
Indicates the current version of the data that has been set. This is incremented with every set call for that type of data (read-only, internal, etc). This version can be provided in Get calls to find updated data. |
UserDataPermission
Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.
| Name | Type | Description |
|---|---|---|
| Private |
string |
|
| Public |
string |
UserDataRecord
| Name | Type | Description |
|---|---|---|
| LastUpdated |
string |
Timestamp for when this data was last updated. |
| Permission |
Indicates whether this data can be read by all users (public) or only the user (private). This is used for GetUserData requests being made by one player about another player. |
|
| Value |
string |
Data stored for the specified user data key. |
Error Codes
| Name | Code |
|---|---|
| CharacterNotFound | 1135 |
| UserisNotValid | 1030 |