Catalog - Submit Item Review Vote

Service:

Economy

API Version:

241122

Submit a vote for a review, indicating whether the review was helpful or unhelpful.

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

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 of the item associated with the review.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
ItemId	string	The string ID of the item associated with the review.
ReviewId	string	The ID of the review to submit a helpfulness vote for.
Vote	HelpfulnessVote	The helpfulness vote of the review.

Responses

Name	Type	Description
200 OK	SubmitItemReviewVoteResponse
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
EntityKey	Combined entity type and ID structure which uniquely identifies a single entity.
HelpfulnessVote
SubmitItemReviewVoteRequest
SubmitItemReviewVoteResponse

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.

EntityKey

Combined entity type and ID structure which uniquely identifies a single entity.

Name	Type	Description
Id	string	Unique ID of the entity.
Type	string	Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

HelpfulnessVote

Name	Type	Description
Helpful	string
None	string
UnHelpful	string

SubmitItemReviewVoteRequest

Name	Type	Description
AlternateId	CatalogAlternateId	An alternate ID of the item associated with the review.
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Entity	EntityKey	The entity to perform this action on.
ItemId	string	The string ID of the item associated with the review.
ReviewId	string	The ID of the review to submit a helpfulness vote for.
Vote	HelpfulnessVote	The helpfulness vote of the review.

SubmitItemReviewVoteResponse

Error Codes

Name	Code
DatabaseThroughputExceeded	1113