diff options
| author | Ken <kenny@madgloryint.com> | 2017-11-01 13:27:17 -0400 |
|---|---|---|
| committer | Ken <kenny@madgloryint.com> | 2017-11-01 13:27:17 -0400 |
| commit | 1385a3cefc7312a3f18e8d78a854411b53c75e67 (patch) | |
| tree | f27292fc20215f68c25ab09830947da56fb732a9 /build/html/_sources/teams/teams.rst.txt | |
| parent | 0f19a09673be2bb79426e21a6460d5095f43287a (diff) | |
| download | vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.tar.gz vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.zip | |
Initial commit of the new logs.
Diffstat (limited to 'build/html/_sources/teams/teams.rst.txt')
| -rw-r--r-- | build/html/_sources/teams/teams.rst.txt | 73 |
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 |
