POST /titles/{titleId}/recentplayers/server

Appends to or updates a set of users’ lists of recent players (unidirectional). This is essentially a batch API of the client API, for servers. This API allows a game server to append to a set of users’ lists of recent players, and to update existing recent player entries. Each user’s recent players list is unidirectional.

POST /titles/{titleId}/recentplayers/server

URI parameters

Parameter	In	Required	Type	Description
titleId	path	TRUE	integer	The titleId of the game that the request is being sent for.

Request header

Name	Required	Type	Description
Authorization	TRUE	integer	Caller must supply an XToken in the XBL 3.0 authorization format. For example, Authorization: XBL3.0 x=2553948354698;>encrypted token<)
Content-Type	TRUE	string	ContentType must be set to application/json

Request body

Name	Required	Type	Description
recentPlayersByXuid	TRUE	ServerRecentPlayersByXuid[]	Array of objects representing a XUID and their recent players. There should be at least 1 and at most 20 XUID entries.

Responses

Name	Type	Description
204 No Content		The recent players request was sent successfully.
400 Bad Request	ErrorResponse	An error occurred while processing the request. Possible error codes: “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource.”
Other Status Codes	ThrottledEntity	Too many requests. Headers Retry-After: integer

EncounterType

The type of recent players encounter. This field is optional and defaults to Default. Default has no prescribed meaning - it is up to the caller to interpret this value appropriately.

Name	Type	Description
Default	string
Opponent	string
Teammate	string

ErrorResponse

Name	Type	Description
debugMessage	string	Human readable version of the error message that can be used for debugging.
errorCode	string	Error code enum.

Network

Name	Type	Description
XboxLive	string

ServerRecentPlayersByXuid

Name	Type	Description
recentPlayers	UnidirectionalRecentPlayer[]	The array of recent players for this user. There should be at least 1 recent players and at most 100 recent players.
xuid	string	The user’s XUID (base 10 integer).

ServerRecentPlayersRequest

Name	Type	Description
recentPlayersByXuid	ServerRecentPlayersByXuid[]	Array of objects representing a XUID and their recent players. There should be at least 1 and at most 20 XUID entries.

ThrottledEntity

Name	Type	Description
currentRequests	string	Current number of requests - concurrency or rate.
debugMessage	string	Human readable version of the throttle message that can be used for debugging.
limitType	string	The limit type i.e. concurrency or rate.
maxRequests	string	Max request allowed - concurrency or rate.
periodInSeconds	string	The period in seconds that applies when rate or concurrency limits are exceeded.
version	string	Current throttle contract version.

UnidirectionalRecentPlayer

Name	Type	Description
encounterType	EncounterType	The type of recent players encounter. This field is optional and defaults to Default. Default has no prescribed meaning - it is up to the caller to interpret this value appropriately.
id	string	The Id (a XUID base 10 integer) of another user.
network	Network	The network the other user was encountered on.
timestamp	string

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

URI parameters

Request header

Request body

Responses

Definitions

EncounterType

ErrorResponse

Network

ServerRecentPlayersByXuid

ServerRecentPlayersRequest

ThrottledEntity

UnidirectionalRecentPlayer

​URI parameters

​Request header

​Request body

​Responses

​Definitions

​EncounterType

​ErrorResponse

​Network

​ServerRecentPlayersByXuid

​ServerRecentPlayersRequest

​ThrottledEntity

​UnidirectionalRecentPlayer

URI parameters

Request header

Request body

Responses

Definitions

EncounterType

ErrorResponse

Network

ServerRecentPlayersByXuid

ServerRecentPlayersRequest

ThrottledEntity

UnidirectionalRecentPlayer