Players in Teams - FAQs

The purpose of this guide is to answer some of the Frequently Asked Questions we get in regards to how a user assigns players to teams and how they are available in certain API calls.

The API calls listed below are available in the standard API Calls Documentation.

Livestream API - Pre Match Call

The Pre Match livestream call is used to determine which match details for a given streamKey.

People in the teams section of this call are returned based on the following order of responses:

• People assigned to the match directly. These people must have a Person Match Statistic record with periodNumber=0 and periodType=REGULAR
• If the above returns no people for the team, then the people in the response are returned via assigning a person to a team via the Competition Player Defaults API POST. This call allows a player to assign their current default playerTeamId. A player has one record per competition.
  If a player changes team, this Competition Player Default will contain the most recent (current) team a player is in.

When is this call used ?

Used pre-match to determine the roster of players available for selection in the match.

API - Match Players

The Match Players GET call is used to get a list of the players in a match. These are people who have basically been given a Person Match Statistic record with periodNumber=0 and periodType=REGULAR

This call has the an option to pass a teamId to limit the response to a single team.

When is this call used ?

Generally used after a match to get a list of the players who received statistic records.

API - Persons

The generic persons API call has a series of GET list calls that return a series of people.

The list of people records returned completely depends on a series of required & optional parameters.

• isPlayer - Requires that the person has a Person Match Statistic record. Its in the statistic record that the isPlayer field is stored.
• isCurrent - Requires that the person has a Person Match Statistic record.
• matchId - Requires that the person has a Person Match Statistic record.

The calls available are (overlayed with any extra parameter filter listed above):

• Persons for a leagueId - Assuming no other filters, the most basic version of this call returns people in the league./li>
• Persons for a clubId - This is based on the club a team is in via Competition Player Defaults
• Persons for a teamId - This is based on if the person is in the team via Competition Player Defaults
• Persons for a competitionId and a teamId - This is based on the competition & team from either Competition Player Defaults or Person Match Statistics if any of the isPlayer or isCurrent flags are set
• Persons for a competitionId, a matchId and a teamId - This is based on Person Match Statistics data.

These above series of GET calls also have optional paramters such as:

• primaryTeamId This field is used only for biographic details. By setting this field, the player isn't available in Pre-Match calls.
• primaryClubId This field is used only for biographic details. By setting this field, the player isn't available in Pre-Match calls.

When is this call used ?

This series of GET calls are generally used to return simple lists of person records matching the appropriate filters.