Skip to content

Get Platform Session Info

GET
/session/v1/platform/{platform}/platform-session/{platform_session_id_base64}

Get information about a platform session

Required Permissions:

  • For any player (including themselves) any of: session:*, session:read:platform

Required Session Permissions: SessionPermissions.active_in_session for users that do not have the session:read:any auth permission

Authorizations

Parameters

Path Parameters

platform
required

An enumeration.

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
platform_session_id_base64
required
string
>= 1 characters <= 4096 characters

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be returned - indicating that the resource has not changed.

Responses

200

Successful Response

A platform session resource in a RallyHere session

object
platform
required

Platform that this session is for

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
platform_session_type
required

Platform-Specific Identifier for the Platform’s template

string
>= 1 characters <= 128 characters
platform_session_id_base64
required

Platform session’s unique identifier

string
>= 1 characters <= 4096 characters
players
required

DEPRECATED. PlatformSessions no longer keep tracking of players. Players in the platform session

Array<object>

A platform player resource in a platform session

object
player_id

Player ID representing the current player

integer
player_uuid
required

Player UUID representing the current player

string format: uuid
leader

Is this player the leader of the platform session? When setting up the parent session, if all players are from the same platform session, leadership is coordinated

boolean
custom_data

Product defined custom data fields about the platform session

object
key
additional properties
string
>= 1 characters <= 4096 characters

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

403

User is not authenticated, or does not have sufficient role access to perform request

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Platform Session or Platform Player doesn’t exist. See error code for more info

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string