Public Attributes | List of all members
GetPlayerCategoriesRequest Struct Reference

Input parameters of the GetPlayerCategories API. More...

Public Attributes

 $Credentials
 
 $Season
 
 $UniqueIndex
 
 $ShortNameSearch
 
 $RankingCategory
 

Detailed Description

Input parameters of the GetPlayerCategories API.

See also
GetPlayerCategories

Member Data Documentation

◆ $Credentials

GetPlayerCategoriesRequest::$Credentials

Defines credentials (username and password) to connect to a TabT website

This parameter is optional. Additional information about the configuration of the player category will be given if valid credentials are given.

type: CredentialsType

◆ $RankingCategory

GetPlayerCategoriesRequest::$RankingCategory

The ranking categoy to consider.

This parameter is optional. By default, all player categories are returned.

@ var integer

◆ $Season

GetPlayerCategoriesRequest::$Season

The season to consider

This parameter is optional, default is the current season (see GetSeasons)

type: int

◆ $ShortNameSearch

GetPlayerCategoriesRequest::$ShortNameSearch

The pattern of the player categoy short name to match. The wildcard character is the percent sign (%). The search is not case sensitive.

This parameter is optional. By default, all player categories are returned.

@ var string

◆ $UniqueIndex

GetPlayerCategoriesRequest::$UniqueIndex

The unique internal index of the player category

This parameter is optional. By default, all player categories are returned.

type: int


The documentation for this struct was generated from the following file: