Post Server Recent Player Group

Appends to or updates all users' recent players within a group (bidirectional).

This API allows a game server to append to a set of users' lists of recent players, and to update existing recent player entries. All users within a group are added to each other's recent players lists (bidirectional).

Example of recent player groups: [ [A,B,C], [A,D], [E,F] ].

A met B, C, and D. B met A and C. D only met A and so on.

POST /titles/{titleId}/recentplayergroups/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
recentPlayerGroups	TRUE	RecentPlayerGroup[]	The array of bidirectional recent player groups. There should be at least 1 group and at most 20 groups. Within each group, there should be at least 2 players, and at most 100.

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

Definitions

• BidirectionalRecentPlayer
• EncounterType
• ErrorResponse
• Network
• RecentPlayerGroup
• ServerRecentPlayerGroupsRequest
• ThrottledEntity

BidirectionalRecentPlayer

Name	Type	Description
id	string	The Id (a XUID base 10 integer) of another user.
network	Network	The network the other user was encountered on.

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

RecentPlayerGroup

All users within a group have encountered each other at the specified time. Each group must contain at least 2 and up to 100 users.

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.
recentPlayers	BidirectionalRecentPlayer[]
timestamp	string

ServerRecentPlayerGroupsRequest

All users within a group have encountered each other at the specified time. Each group must contain at least 2 and up to 100 users.

Name	Type	Description
recentPlayerGroups	RecentPlayerGroup	The array of bidirectional recent player groups. There should be at least 1 group and at most 20 groups. Within each group, there should be at least 2 players, and at most 100.

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.