Overview
LaunchPlayerByGSIS and LaunchPlayerByGSISNonPro launch GSIS plays in Thunder using GSIS game and play identifiers.
These launch methods use the simplified LaunchPlayer payload structure, where the <payload> element contains a delimited list of GSIS play references.
Use:
- LaunchPlayerByGSIS to launch GSIS plays.
- LaunchPlayerByGSISNonPro to launch NCAA/non-pro GSIS plays.
Both methods use the same payload format.
URL Format
LaunchPlayerByGSIS
/XOS/launchplayerbygsis?gameCodePlayId=<root>...</root>LaunchPlayerByGSISNonPro
/XOS/launchplayerbygsisnonpro?gameCodePlayId=<root>...</root>Authentication
Thunder launch URLs require a valid authentication token in the <authentication> XML element.
For information on:
- Generating authentication tokens
- Vendor GUID requirements
- Token duration and expiration
- Authentication examples
See:
Thunder API – Authentication Token
Common XML Structure
Both LaunchPlayerByGSIS and LaunchPlayerByGSISNonPro use the same XML payload structure.
<root>
<authentication token='TOKEN' vendor='VENDOR_GUID'/>
<payload>
^GAMEKEY|PLAYID
</payload>
</root>Request Parameters
| Launch Method | Parameter | Description |
|---|---|---|
| LaunchPlayerByGSIS | gameCodePlayId |
Delimited list of GSIS GameKey and PlayId values |
| LaunchPlayerByGSISNonPro | gameCodePlayId |
Delimited list of GSIS GameKey and PlayId values |
Payload Format
GSIS play references use the following format:
GAMEKEY|PLAYIDTo specify a team perspective, include an optional ScoutedTeam value:
GAMEKEY|PLAYID:SCOUTEDTEAMMultiple plays for the same game may be grouped using comma-delimited Play IDs.
Example:
^55514|944,4340,4579Multiple games are separated using the ^ character.
Example:
^55514|944,4340,4579
^55526|1583,1625,1942,3978
^55546|444,1327,2090,2860,1033Play Reference Fields
| Field | Required | Description |
|---|---|---|
GAMEKEY |
Yes | GSIS game identifier |
PLAYID |
Yes | GSIS play identifier |
SCOUTEDTEAM |
No | Team code used to determine play perspective |
ScoutedTeam
ScoutedTeam is optional.
When supplied, Thunder resolves the play using the specified team perspective.
For GSIS launches, ScoutedTeam uses Thunder team codes.
ScoutedTeam requires extended API support permissions.
Example XML Structure
<root>
<authentication token='TOKEN' vendor='VENDOR_GUID'/>
<payload>
^55514|944,4340,4579
^56852|307:ATL,336:ATL,357:ATL
</payload>
</root>Notes
- Both methods use GSIS
GameKeyandPlayIdvalues. - Multiple plays from the same game may be grouped using comma-delimited Play IDs.
- Multiple games are separated using the
^character. -
ScoutedTeamis optional and uses Thunder team codes.
Comments
0 comments
Please sign in to leave a comment.