Catalog - Get Item Moderation State

Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation

POST https://titleId.playfabapi.com/Catalog/GetItemModerationState

Request Header

Name Required Type Description
X-EntityToken True

string

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

Request Body

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Id

string

The unique ID of the item.

Responses

Name Type Description
200 OK

GetItemModerationStateResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

CatalogAlternateId
GetItemModerationStateRequest
GetItemModerationStateResponse
ModerationState
ModerationStatus

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

CatalogAlternateId

Name Type Description
Type

string

Type of the alternate ID.

Value

string

Value of the alternate ID.

GetItemModerationStateRequest

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Id

string

The unique ID of the item.

GetItemModerationStateResponse

Name Type Description
State

ModerationState

The current moderation state for the requested item.

ModerationState

Name Type Description
LastModifiedDate

string

The date and time this moderation state was last updated.

Reason

string

The current stated reason for the associated item being moderated.

Status

ModerationStatus

The current moderation status for the associated item.

ModerationStatus

Name Type Description
Approved

string

AwaitingModeration

string

Rejected

string

Unknown

string

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047