Thunder API – GetAllPlayFieldHeadings

Overview

GetAllPlayFieldHeadings returns a list of available Thunder play fields.

The response includes metadata describing each field, including the field key, display name, data type, editability, allowed values, and category.

This endpoint is commonly used to determine valid key values for SearchForPlaysComplex queries.

Endpoint

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

Authentication Headers

GetAllPlayFieldHeadings requires API authentication headers.

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

Thunder API – Authentication Headers

Response

The API returns a list of available play field headings.

Response content type:

application/json

Example response:

[
  {
    "FieldKey": "Football.Down",
    "Name": "Down",
    "DataType": "Integer",
    "MaxLength": 0,
    "CanEdit": true,
    "Values": [
      "1",
      "2",
      "3",
      "4"
    ],
    "Category": "Football",
    "ValueType": "SingleSelect"
  }
]

Response Fields

Example Usage

FieldKey values are commonly used in SearchForPlaysComplex.

Example:

<criteria op='Equal' key='Football.Down' val='1'/>

Related Articles

• Thunder API – Authentication Headers
• Thunder API – SearchForPlaysComplex