Thunder API – SearchForPlaysComplex

Overview

SearchForPlaysComplex returns plays that match supplied filter criteria.

The search criteria are supplied as XML, converted to Base64, and passed using the criteria query parameter.

All criteria must be satisfied for a play to be included in the response.

Valid play field keys can be retrieved using:

Thunder API – GetAllPlayFieldHeadings

Valid Game Property keys and supported operators can be retrieved using:

Thunder API – GetGamePropertyInfo

Endpoint

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

Authentication Headers

SearchForPlaysComplex requires API authentication headers.

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

Thunder API – Authentication Headers

Parameters

Criteria XML Structure

The criteria parameter uses XML containing one or more criteria elements.

<criterias>
    <criteria key='FIELD_KEY' op='OPERATOR' val='VALUE'/>
</criterias>

Each criteria element defines one filter condition.

Criteria Attributes

For multiple values, use nested value elements instead of the val attribute.

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

Example Criteria

Example 1 – Search by Down, Game Key, and Game Date

<criterias>
    <criteria op='Equal' key='Football.Down'>
        <value val='1'/>
        <value val='3'/>
    </criteria>
    <criteria op='Equal' key='Football.GSISGamekey' val='57242'/>
    <criteria op='Is_In_Between' key='Football.GameDate'>
        <value val='2017-09-01'/>
        <value val='2017-10-01'/>
    </criteria>
</criterias>

Example 2 – Search by Game Property

<criterias>
    <criteria op='Equal' key='Football.Down'>
        <value val='1'/>
        <value val='3'/>
    </criteria>
    <criteria op='Equal' gamepropertykey='GameType' val='Regular Season'/>
    <criteria op='Equal' gamepropertykey='ScoutedTeamId' val='TEAM_GUID'/>
</criterias>

Request Format

After creating the criteria XML:

1. Convert the XML to Base64
2. URL-encode the Base64 value
3. Supply the value using the criteria query parameter

https://tclightningservices.xosdigital.com/Api/ThunderAPI/SearchForPlaysComplex?criteria={BASE64_ENCODED_XML}&includeClips=false

includeClips

includeClips controls whether clip/video information is included in the response.

Use includeClips=false when clip/video URLs are not required.

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": [],
    "ViewSequenceId": "string",
    "ClipTypeId": "string",
    "ViewList": [],
    "DrawingList": {},
    "EditPlayMetadatas": [],
    "EditPlayId": "00000000-0000-0000-0000-000000000000",
    "EditPlayIndex": 0,
    "TCPlayType": 0
  }
]

Notes

• All criteria must be satisfied for a play to be returned.
• Decimal values are rounded to one decimal place before comparison.
• Is_In_Between includes values equal to the search limits.
• Multiple values with Equal return plays matching any supplied value.

For information on retrieving valid play field keys, see:

Thunder API – GetAllPlayFieldHeadings

For information on retrieving valid Game Property keys and supported operators, see:

Thunder API – GetGamePropertyInfo

Related Articles

• Thunder API – Authentication Headers
• Thunder API – GetAllPlayFieldHeadings
• Thunder API – GetGamePropertyInfo
• Thunder API – SaveEditURL