Overview

GetPlays returns play data for the specified Thunder play IDs.

Thunder provides both GET and POST versions of this endpoint:

• GetPlays uses the GET verb and accepts a colon-delimited list of Thunder play IDs.
• GetPlaysPost uses the POST verb and accepts a JSON request body containing Thunder play IDs.

Both endpoints return the same play response structure.

Endpoints

GET

GET https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlays

POST

POST https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysPost

Authentication Headers

GetPlays and GetPlaysPost require Thunder API  authentication headers.

For required authentication headers and how to generate the authorization value, see:

Thunder API – Authentication Headers

GET Request

Use GetPlays when submitting Thunder play IDs as a colon-delimited query string value.

Parameters

Request Format

https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlays?playIDs={PLAYID_1}:{PLAYID_2}

Example

https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlays?playIDs=df4d1395-f752-4671-9a20-032de9df4650:cb65b95f-0228-4a18-af3f-926e8b6682f7

POST Request

Use GetPlaysPost when submitting Thunder play IDs in a JSON request body.

Endpoint

POST https://tclightningservices.xosdigital.com/Api/ThunderAPI/GetPlaysPost

Content Type

application/json

Request Body Example

{
  "playIDs": [
    "df4d1395-f752-4671-9a20-032de9df4650"
  ]
}

Request Body Model

{
  "playIDs": [
    "string"
  ]
}

Body Parameters

Response

The API returns an array of play objects.

Response Content Type

application/json

Example Response Structure

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "PlayFieldValues": {},
    "Clips": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "ViewId": "00000000-0000-0000-0000-000000000000",
        "MediaReferenceId": "00000000-0000-0000-0000-000000000000",
        "FrameStart": 0,
        "FrameEnd": 0,
        "Json": "string",
        "IsOverride": true,
        "DrawXML": "string",
        "MediaFrameStart": 0,
        "MediaFrameEnd": 0,
        "FPS": 0,
        "OriginalFPS": 0,
        "TimeIn": "string",
        "TimeOut": "string"
      }
    ],
    "ViewSequenceId": "string",
    "ClipTypeId": "string",
    "ViewList": [
      {
        "Id": "00000000-0000-0000-0000-000000000000",
        "Name": "string"
      }
    ],
    "DrawingList": {},
    "EditPlayMetadatas": [
      {
        "EditPlayMetadataId": "00000000-0000-0000-0000-000000000000",
        "EditPlayId": "00000000-0000-0000-0000-000000000000",
        "ViewId": "00000000-0000-0000-0000-000000000000",
        "Index": 0,
        "Name": "string",
        "SubName": "string",
        "Value": "string"
      }
    ],
    "EditPlayId": "00000000-0000-0000-0000-000000000000",
    "EditPlayIndex": 0,
    "TCPlayType": 0
  }
]

Notes

• Thunder play IDs must be supplied in GUID form.
• Use GetPlays for GET requests with colon-delimited play IDs.
• Use GetPlaysPost for POST requests with a JSON request body.
• Both endpoints return the same play object structure.
• GetPlaysPost is generally easier to use when requesting a larger number of play IDs.

Related Articles

• Thunder API – Authentication Headers