summaryrefslogtreecommitdiff
path: root/build/html/_sources/teams/teams.rst.txt
diff options
context:
space:
mode:
Diffstat (limited to 'build/html/_sources/teams/teams.rst.txt')
-rw-r--r--build/html/_sources/teams/teams.rst.txt73
1 files changed, 73 insertions, 0 deletions
diff --git a/build/html/_sources/teams/teams.rst.txt b/build/html/_sources/teams/teams.rst.txt
new file mode 100644
index 0000000..f380805
--- /dev/null
+++ b/build/html/_sources/teams/teams.rst.txt
@@ -0,0 +1,73 @@
+.. _teams:
+
+Teams
+=====
+
+Team objects contain aggregated lifetime information about each Team.
+
+Get a collection of Teams
+---------------------------
+
+This endpoint retrieves a collection of up to 6 teams.
+
+*Important - Team resources are not yet available in the API.*
+
+**HTTP Request**
+
+| ``GET https://api.dc01.gamelockerapp.com/teams``
+
+**URL Parameters**
+
+| Parameter: filter[teamNames]
+| Defailt: none
+| Description: Filters by team name. Usage: filter[teamNames]=team1
+
+| Parameter: filter[teamIds]
+| Defailt: none
+| Description: Filter by team id. Usage: filter[teamIds]=12345
+
+**Shell:**
+
+.. code-block:: shell
+
+ curl "https://api.dc01.gamelockerapp.com/shards/na/teams?filter[teamNames]=team1" \
+ -H "Authorization: Bearer <api-key>" \
+ -H "Accept: application/vnd.api+json"
+
+
+
+Get a Single Team
+---------------------------
+
+This endpoint retrieves a specific team.
+
+**HTTP Request**
+
+| ``GET https://api.dc01.gamelockerapp.com/teams/<ID>``
+
+**URL Parameters**
+
+| Parameter: ID
+| Description: The ID of the team to retrieve
+
+
+**Shell:**
+
+.. code-block:: shell
+
+ curl "https://api.dc01.gamelockerapp.com/teams/<ID>" \
+ -H "Authorization: Bearer <api-key>" \
+ -H "Accept: application/vnd.api+json"
+
+ The above command returns JSON structured like this:
+
+ {
+ "id": 2,
+ "name": "Max",
+ "breed": "unknown",
+ "fluffiness": 5,
+ "cuteness": 10
+ }
+
+.. toctree::
+ :maxdepth: 2