JavaScript Object Notation (JSON) Object Reference

JavaScript Object Notation (JSON) is a lightweight, standards-based, object-oriented notation for encapsulating data on the web.

Xbox Live Services defines JSON objects that are used in requests to, and responses from, the service. This section provides reference information about each JSON object used with Xbox Live Services.

In this section

Article Description
Achievement (JSON) An Achievement object (version 2).
ActivityRecord (JSON) A formatted and localized string about one or more users' rich presence.
ActivityRequest (JSON) A request for information about one or more users' rich presence.
AggregateSessionsResponse (JSON) Contains aggregated data for a user's fitness sessions.
BatchRequest (JSON) An array of properties with which to filter presence information, such as users, devices, and titles.
DeviceEndpoint (JSON) The endpoint for a device.
DeviceRecord (JSON) Information about a device, including its type and the titles active on it.
Feedback (JSON) Contains feedback information about a player.
GameClip (JSON) A recording of gameplay.
GameClipsServiceErrorResponse (JSON) An optional part of the response to the /users/{ownerId}/scids/{scid}/clips/{gameClipId}/uris/format/{gameClipUriType} API.
GameClipThumbnail (JSON) Contains the information related to an individual thumbnail. There can be multiple sizes per clip, and it is up to the client to select the proper one for display.
GameClipUri (JSON) The URI for a recording of gameplay.
GameMessage (JSON) A JSON object defining data for a message in a game session's message queue.
GameResult (JSON) A JSON object representing data that describes the results of a game session.
GameSession (JSON) A JSON object representing game data for a multiplayer session.
GameSessionSummary (JSON) A JSON object representing summary data for a game session.
GetClipResponse (JSON) Wraps the game clip.
HopperStatsResults (JSON) A JSON object representing the statistics for a hopper.
InitialUploadRequest (JSON) The body of a POST GameClip upload request.
InitialUploadResponse (JSON) The body of a POST GameClip upload response.
inventoryItem (JSON) The core inventory item represents the standard item on which an entitlement can be granted.
LastSeenRecord (JSON) Information about when the system last saw a user, available when the user has no valid DeviceRecord.
MatchTicket (JSON) A JSON object representing a match ticket, used by players to locate other players through the multiplayer session directory (MPSD).
MediaAsset (JSON) The media assets associated with the achievement or its rewards.
MediaRecord (JSON) A record about the media used by the Bing catalog or provider catalog.
MediaRequest (JSON) A request for media used by the Bing catalog or provider catalog.
MultiplayerActivityDetails (JSON) A JSON object representing the Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails.
MultiplayerSessionReference (JSON) A JSON object representing the MultiplayerSessionReference.
MultiplayerSessionRequest (JSON) The request JSON object passed for an operation on a MultiplayerSession object.
MultiplayerSession (JSON) A JSON object representing the MultiplayerSession.
PagingInfo (JSON) Contains paging information for results that are returned in pages of data.
PeopleList (JSON) Collection of Person objects.
PermissionCheckBatchRequest (JSON) Collection of PermissionCheckBatchRequest objects.
PermissionCheckBatchResponse (JSON) The results of a batch permission check for a list of permission values for multiple users.
PermissionCheckBatchUserResponse (JSON) The reasons of a batch permission check for list of permission values for a single target user.
PermissionCheckResponse (JSON) The results of a check from a single user for a single permission setting against a single target user.
PermissionCheckResult (JSON) The results of a check from a single user for a single permission setting against a single target user.
Person (JSON) Metadata about a single Person in the People system.
PersonSummary (JSON) Collection of Person (JSON) objects.
Player (JSON) Contains data for a player in a game session.
PresenceRecord (JSON) Data about the online presence of a single user.
Profile (JSON) The personal profile settings for a user.
Progression (JSON) The user's progression toward unlocking the achievement.
Property (JSON) Contains property data provided by the client for matchmaking request criteria.
QueryClipsResponse (JSON) Wraps the list of return game clips along with paging information for the list.
quotaInfo (JSON) Contains quota information about a title group.
Requirement (JSON) The unlock criteria for the Achievement and how far the user is toward meeting them.
ResetReputation (JSON) Contains the new base Reputation scores to which a user's existing scores should be changed.
Reward (JSON) The reward associated with the achievement.
RichPresenceRequest (JSON) Request for information about which rich presence information should be used.
ServiceError (JSON) Contains information about an error returned when a call to the service failed.
ServiceErrorResponse (JSON) When a service error is encountered, an appropriate HTTP error code will be returned. Optionally, the service may also include a ServiceErrorResponse object as defined below. In production environments, less data may be included.
SessionEntry (JSON) Contains data for a fitness session.
TitleAssociation (JSON) A title that is associated with the achievement.
TitleBlob (JSON) Contains information about a title from storage.
TitleRecord (JSON) Information about a title, including its name and a last-modified timestamp.
TitleRequest (JSON) Request for information about a title.
User (JSON) Contains user leaderboard data.
UserClaims (JSON) Returns information about the current authenticated user.
UserList (JSON) A collection of User objects.
UserSettings (JSON) Returns settings for current authenticated user.
UserTitle (JSON) Contains user title data.
VerifyStringResult (JSON) Result codes corresponding to each string submitted to /system/strings/validate.
XuidList (JSON) List of XUIDs on which to perform an operation.

See also


Xbox Live Services RESTful Reference

ECMA International Standard 262: ECMAScript Language Specification