Thunder API – LaunchPlayerByPlays / LaunchPlayerByEdits

Overview

LaunchPlayerByPlays and LaunchPlayerByEdits launch XOS content in Thunder using GUID-based identifiers.

These launch methods use the simplified LaunchPlayer payload structure, where the <payload> element contains a comma-delimited list of identifiers.

Use:

• LaunchPlayerByPlays to launch XOS plays using XOS play IDs.
• LaunchPlayerByEdits to launch Thunder edits using XOS edit IDs.

URL Format

LaunchPlayerByPlays

/XOS/launchplayerbyplays?plays=<root>...</root>

LaunchPlayerByEdits

/XOS/launchplayerbyedits?edits=<root>...</root>

Authentication

LaunchPlayerByPlays and LaunchPlayerByEdits require a valid authentication token in the launch XML.

For information on:

• Generating authentication tokens
• Vendor GUID requirements
• Token duration and expiration
• Authentication examples

See:

Thunder API – Authentication Token

Common XML Structure

Both LaunchPlayerByPlays and LaunchPlayerByEdits use the same XML payload structure.

<root>
    <authentication token='TOKEN' vendor='VENDOR_GUID'/>
    <payload>
        ID_1,ID_2,ID_3
    </payload>
</root>

Request Parameters

LaunchPlayerByPlays

LaunchPlayerByPlays launches XOS plays using XOS play IDs.

Payload Format

PLAYID_1,PLAYID_2,PLAYID_3

Example XML Structure

<root>
    <authentication token='TOKEN' vendor='VENDOR_GUID'/>
    <payload>
        1E1EB397-7A5A-4B60-80F8-085A5688447B,
        6277E72E-ABC9-4394-8EE8-CB7C8B84FD2C
    </payload>
</root>

Notes

• Uses XOS play GUIDs.
• Play IDs are comma-delimited.
• Uses the same XOS play IDs as XOSMessageXMLGet and XOSMessageXML.

LaunchPlayerByEdits

LaunchPlayerByEdits launches Thunder edits using XOS edit IDs.

Payload Format

EDITID_1,EDITID_2,EDITID_3

Example XML Structure

<root>
    <authentication token='TOKEN' vendor='VENDOR_GUID'/>
    <payload>
        1E1EB397-7A5A-4B60-80F8-085A5688447B,
        6277E72E-ABC9-4394-8EE8-CB7C8B84FD2C
    </payload>
</root>

Notes

• Uses XOS edit GUIDs.
• Edit IDs are comma-delimited.
• The query string parameter is edits, not plays.

Related Articles

• Thunder API – Authentication Token
• Thunder API – Creating Thunder Launch URLs
• Thunder API – LaunchPlayerByGSIS / LaunchPlayerByGSISNonPro
• Thunder API – LaunchPlayer