Difference between revisions of "WebAPI:Teams"

From Starsonata Wiki
Jump to: navigation, search
Line 1: Line 1:
 
Returns a list of all player [[team|teams]].
 
Returns a list of all player [[team|teams]].
  
 +
==Response==
 +
Returns an array teams keyed by team ID. Each team has the following attributes.
 +
* <code>teamID</code> - The ID of the team used all over the website and api endpoints. Can be used to retrieve the team flag or the team web page.
 +
* <code>name</code> - The team name.
 +
* <code>totalscore</code> - The current total [[Team Score|score]] of a team.
 +
* <code>member_count</code> - The current number of characters on a team.
  
 +
Note: totalscore and member_count will likely be missing on inactive teams.
 
[[Category:WebAPI]]
 
[[Category:WebAPI]]

Revision as of 19:32, 14 June 2018

Returns a list of all player teams.

Response

Returns an array teams keyed by team ID. Each team has the following attributes.

  • teamID - The ID of the team used all over the website and api endpoints. Can be used to retrieve the team flag or the team web page.
  • name - The team name.
  • totalscore - The current total score of a team.
  • member_count - The current number of characters on a team.

Note: totalscore and member_count will likely be missing on inactive teams.