diff options
Diffstat (limited to 'build/html/teams/teams.html')
| -rw-r--r-- | build/html/teams/teams.html | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/build/html/teams/teams.html b/build/html/teams/teams.html new file mode 100644 index 0000000..0627a2a --- /dev/null +++ b/build/html/teams/teams.html @@ -0,0 +1,189 @@ + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <title>Teams — Battelrite 0.2 documentation</title> + <link rel="stylesheet" href="../_static/css/battlerite.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '0.2', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Links" href="../links/links.html" /> + <link rel="prev" title="Telemetry" href="../telemetry/telemetry.html" /> + <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> + </head> + <body> +<header id="BTT" role="banner"> + <div class="menu-top-outer clearfix"> + <div class="wrapper clearfix"> + <a href="/" id="site-logo"></a> + <span id="logSignBtn" class="btn">Login / Signup</span> + <nav id="mainMenu" class="main-menu-con"> + <ul class="main-menu clearfix"> + <li><a class="active" href="guides.html">Documentation</a></li> + <li><a href="faq.html">Faqs</a></li> + <li><a href="creations.html">Creations</a></li> + </ul> + </nav> + </div> + </div> +</header> + + <div class="related top"> + <nav id="rellinks"> + <ul> + <li> + ← + <a href="../telemetry/telemetry.html" title="Previous document">Telemetry</a> + </li> + <li> + <a href="../links/links.html" title="Next document">Links</a> + → + </li> + </ul> + </nav> + <nav id="breadcrumbs"> + <ul> + <li><a href="../index.html">Battelrite 0.2 documentation</a></li> + </ul> + </nav> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="teams"> +<span id="id1"></span><h1>Teams<a class="headerlink" href="#teams" title="Permalink to this headline">¶</a></h1> +<p>Team objects contain aggregated lifetime information about each Team.</p> +<div class="section" id="get-a-collection-of-teams"> +<h2>Get a collection of Teams<a class="headerlink" href="#get-a-collection-of-teams" title="Permalink to this headline">¶</a></h2> +<p>This endpoint retrieves a collection of up to 6 teams.</p> +<p><em>Important - Team resources are not yet available in the API.</em></p> +<p><strong>HTTP Request</strong></p> +<div class="line-block"> +<div class="line"><code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/teams</span></code></div> +</div> +<p><strong>URL Parameters</strong></p> +<div class="line-block"> +<div class="line">Parameter: filter[teamNames]</div> +<div class="line">Defailt: none</div> +<div class="line">Description: Filters by team name. Usage: filter[teamNames]=team1</div> +</div> +<div class="line-block"> +<div class="line">Parameter: filter[teamIds]</div> +<div class="line">Defailt: none</div> +<div class="line">Description: Filter by team id. Usage: filter[teamIds]=12345</div> +</div> +<p><strong>Shell:</strong></p> +<div class="highlight-shell"><div class="highlight"><pre><span></span>curl <span class="s2">"https://api.dc01.gamelockerapp.com/shards/na/teams?filter[teamNames]=team1"</span> <span class="se">\</span> +-H <span class="s2">"Authorization: Bearer <api-key>"</span> <span class="se">\</span> +-H <span class="s2">"Accept: application/vnd.api+json"</span> +</pre></div> +</div> +</div> +<div class="section" id="get-a-single-team"> +<h2>Get a Single Team<a class="headerlink" href="#get-a-single-team" title="Permalink to this headline">¶</a></h2> +<p>This endpoint retrieves a specific team.</p> +<p><strong>HTTP Request</strong></p> +<div class="line-block"> +<div class="line"><code class="docutils literal"><span class="pre">GET</span> <span class="pre">https://api.dc01.gamelockerapp.com/teams/<ID></span></code></div> +</div> +<p><strong>URL Parameters</strong></p> +<div class="line-block"> +<div class="line">Parameter: ID</div> +<div class="line">Description: The ID of the team to retrieve</div> +</div> +<p><strong>Shell:</strong></p> +<div class="highlight-shell"><div class="highlight"><pre><span></span> curl <span class="s2">"https://api.dc01.gamelockerapp.com/teams/<ID>"</span> <span class="se">\</span> + -H <span class="s2">"Authorization: Bearer <api-key>"</span> <span class="se">\</span> + -H <span class="s2">"Accept: application/vnd.api+json"</span> + + The above <span class="nb">command</span> returns JSON structured like this: + +<span class="o">{</span> + <span class="s2">"id"</span>: <span class="m">2</span>, + <span class="s2">"name"</span>: <span class="s2">"Max"</span>, + <span class="s2">"breed"</span>: <span class="s2">"unknown"</span>, + <span class="s2">"fluffiness"</span>: <span class="m">5</span>, + <span class="s2">"cuteness"</span>: <span class="m">10</span> +<span class="o">}</span> +</pre></div> +</div> +<div class="toctree-wrapper compound"> +</div> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h3><a href="../index.html">Table Of Contents</a></h3> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li> +<li class="toctree-l1"><a class="reference internal" href="../datacenters/datacenters.html">Datacenters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../authorization/authorization.html">Authorization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../titles/titles.html">Titles</a></li> +<li class="toctree-l1"><a class="reference internal" href="../makingrequests/makingrequests.html">Making Requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="../receivingresponses/receivingresponses.html">Receiving Responses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../matches/matches.html">Matches</a></li> +<li class="toctree-l1"><a class="reference internal" href="../match_data_summary/match_data_summary.html">Match Data Summary</a></li> +<li class="toctree-l1"><a class="reference internal" href="../players/players.html">Players</a></li> +<li class="toctree-l1"><a class="reference internal" href="../samples/samples.html">Samples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../telemetry/telemetry.html">Telemetry</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Teams</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#get-a-collection-of-teams">Get a collection of Teams</a></li> +<li class="toctree-l2"><a class="reference internal" href="#get-a-single-team">Get a Single Team</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../links/links.html">Links</a></li> +<li class="toctree-l1"><a class="reference internal" href="../community_sdks/community_sdks.html">Community SDKs</a></li> +<li class="toctree-l1"><a class="reference internal" href="../errors/errors.html">Errors</a></li> +<li class="toctree-l1"><a class="reference internal" href="../changelog/changelog.html">Changelog</a></li> +</ul> + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related bottom"> + <nav id="rellinks"> + <ul> + <li> + ← + <a href="../telemetry/telemetry.html" title="Previous document">Telemetry</a> + </li> + <li> + <a href="../links/links.html" title="Next document">Links</a> + → + </li> + </ul> + </nav> + <nav id="breadcrumbs"> + <ul> + <li><a href="../index.html">Battelrite 0.2 documentation</a></li> + </ul> + </nav> + </div> + + </body> +</html>
\ No newline at end of file |