Session Directory URIs

  • Article

This section provides detail about the Universal Resource Identifier (URI) addresses and associated Hypertext Transport Protocol (HTTP) methods from Xbox Live Services for the Multiplayer Session Directory (MPSD).

Note:
Only titles for games running on an Xbox 360, on a Windows Phone device, or on Xbox.com can use the session directory URIs.

Domain

sessiondirectory.xboxlive.com

Service version

Callers of these REST URIs must pass the value 104/105 or later for X-Xbl-Contract-Version, the HTTP header that specifies the service version of Entertainment Discovery Services (EDS).

System objects and properties

For configuration of its sessions and templates, the MPSD uses a number of session JSON objects that conform with fixed schemas that the directory enforces and interprets. During calls to the methods supported by the various session directory URIs, these objects are validated and merged, based on the supported schemas. The main JSON objects associated with multiplayer configuration are:

Associated JSON objects that are concerned specifically with games are:

Handles

For 2015 Multiplayer only, sessions can be accessed through session handles. Several URIs have been added to provide functionality to support handles.

In this section

/handles

  Supports a POST operation to set the session for the user's current activity to be displayed in Xbox One dashboard user experience, and to invite session members if required.

/handles/{handleId}

  Supports DELETE and GET operations for session handles specified by identifier.

/handles/{handleId}/session

  Supports PUT and GET operations for a session, using handle dereferencing.

/handles/query

  Supports POST operations to create queries for session handles.

/serviceconfigs/{scid}/batch

  Supports a POST operation for a batch query at the service configuration identifier level.

/serviceconfigs/{scid}/sessions

  Supports a GET operation to retrieve a set of session documents.

/serviceconfigs/{scid}/sessiontemplates

  Supports a GET operation to retrieve a set of MPSD session templates.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}

  Supports a GET operation to retrieve a set of session template names.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/batch

  Supports a POST operation to create a batch query at the session template level.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions

  Supports a GET operation to retrieve a set of session templates with the specified template names.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName}

  Supports PUT and GET operations to create and retrieve sessions.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName}/members/me

  Supports a DELETE operation to remove session members.

/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName}/servers/{server-name}

  Supports a DELETE operation to remove the specified server of a session.

See also

Matchmaking URIs

Parent

Universal Resource Identifier (URI) Reference