다음을 통해 공유


Catalog - Takedown Item Reviews

Submit a request to takedown one or more reviews.

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

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
CustomTags

object

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

Reviews

ReviewTakedown[]

The set of reviews to take down.

Responses

Name Type Description
200 OK

TakedownItemReviewsResponse

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
ReviewTakedown
TakedownItemReviewsRequest

Submit a request to takedown one or more reviews, removing them from public view. Authors will still be able to see their reviews after being taken down.

TakedownItemReviewsResponse

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.

ReviewTakedown

Name Type Description
AlternateId

CatalogAlternateId

An alternate ID associated with this item.

ItemId

string

The ID of the item associated with the review to take down.

ReviewId

string

The ID of the review to take down.

TakedownItemReviewsRequest

Submit a request to takedown one or more reviews, removing them from public view. Authors will still be able to see their reviews after being taken down.

Name Type Description
CustomTags

object

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

Reviews

ReviewTakedown[]

The set of reviews to take down.

TakedownItemReviewsResponse

Error Codes

Name Code
DatabaseThroughputExceeded 1113
ItemNotFound 1047