Overview
GetPlaysForURL returns play data based on a Base64URL-encoded Thunder launch URL.
Thunder provides both GET and POST versions of this endpoint:
GetPlaysForURL uses the GET verb and accepts the encoded URL in a query string parameter.
GetPlaysForURLPost uses the POST verb and accepts the encoded URL in a JSON request body.
Both endpoints return the same play response structure.
GetPlaysForURLPost is typically preferred for larger requests because URL query string length limitations do not apply.
Endpoints
GET
GET https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysForURLPOST
POST https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysForURLPostAuthentication Headers
GetPlaysForURL and GetPlaysForURLPost require Thunder API authentication headers.
For required authentication headers and how to generate the authorization value, see:
Thunder API – Authentication Headers
GET Request
Use GetPlaysForURL when submitting a Base64URL-encoded Thunder URL through a query string parameter.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base64Url |
string | Yes | Base64URL-encoded Thunder launch URL |
Request Format
https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysForURL?base64Url={BASE64URL}POST Request
Use GetPlaysForURLPost when submitting a Base64URL-encoded Thunder URL in a JSON request body.
Endpoint
POST https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysForURLPostContent Type
application/jsonRequest Body Example
{
"base64Url": "BASE64URL_VALUE"
}Request Body Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
base64Url |
string | Yes | Base64URL-encoded Thunder launch URL |
Thunder URL Requirements
The base64Url value must contain a valid Base64URL-encoded Thunder launch URL.
Thunder launch URLs support:
LaunchPlayer Request Types
- LaunchPlayerByPlays
- LaunchPlayerByEdits
- LaunchPlayerByGSIS
- LaunchPlayerByGSISNonPro
- LaunchPlayer
MessageXML Request Types
- XOSMessageXMLGet / XOSMessageXML
- MessageXMLGet / MessageXML
- PFFMessageXMLGet / PFFMessageXML
For supported Thunder launch URL formats, see:
Thunder API – Creating Thunder Launch URLs
Example Thunder URL
Example using LaunchPlayerByPlays:
thundercloud://XOS/launchplayerbyplays?plays=
<root>
<authentication token='TOKEN_GUID' vendor='CUSTOMER_GUID'/>
<payload>
PLAY_ID_1,PLAY_ID_2
</payload>
</root>The Thunder launch URL is:
- Converted to Base64URL
- Submitted using the
base64Urlparameter
Lookup URL Support
Previously saved Thunder launch URLs using SaveUserUrlByGuid are also supported.
Example:
thundercloud://XOS/LookupURL?URL={GUID}For information on generating lookup URLs, see:
Thunder API – SaveUserUrlByGuid
Response
The API returns an array of play objects.
Response Content Type
application/jsonResponse Structure
The response structure is identical to:
GetPlays / GetPlaysPost
The response may include:
- Play ID
- Play Name
- Play Field Values
- Clip Information
- View Information
- Drawings
- Metadata
- Edit Play Information
Notes
-
base64Urlmust contain a valid Base64URL-encoded Thunder launch URL. - Use GetPlaysForURL for GET requests.
- Use GetPlaysForURLPost for POST requests with larger payloads.
- Both endpoints return the same play response structure.
- Lookup URLs created using SaveUserUrlByGuid are supported.
Comments
0 comments
Please sign in to leave a comment.