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 /en/teams.md | |
| parent | 0f19a09673be2bb79426e21a6460d5095f43287a (diff) | |
| download | vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.tar.gz vainglory-docs-1385a3cefc7312a3f18e8d78a854411b53c75e67.zip | |
Initial commit of the new logs.
Diffstat (limited to 'en/teams.md')
| -rw-r--r-- | en/teams.md | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/en/teams.md b/en/teams.md deleted file mode 100644 index 994c4fb..0000000 --- a/en/teams.md +++ /dev/null @@ -1,67 +0,0 @@ -# Teams (Coming Soon!) - -Team objects contain aggregated lifetime information about each Team. - -## Get a collection of Teams - -```shell -curl "https://api.dc01.gamelockerapp.com/shards/na/teams?filter[teamNames]=team1" \ - -H "Authorization: Bearer <api-key>" \ - -H "Accept: application/vnd.api+json" -``` - -This endpoint retrieves a collection of up to 6 teams. - -<aside class="warning"> -Important - Team resources are not yet available in the API. -</aside> - -### HTTP Request - -`GET https://api.dc01.gamelockerapp.com/teams` - -### Query Parameters - -Parameter | Default | Description ---------- | ------- | ----------- -filter[teamNames] | none | Filters by team name. Usage: filter[teamNames]=team1 -filter[teamIds] | none | Filter by team id. Usage: filter[teamIds]=12345 - -<aside class="success"> -Remember — a happy team is an authenticated team! -</aside> - -## Get a single Team - -```shell -curl "https://api.dc01.gamelockerapp.com/teams/<ID>" \ - -H "Authorization: Bearer <api-key>" \ - -H "Accept: application/vnd.api+json" -``` - -```python -``` - -> The above command returns JSON structured like this: - -```json -{ - "id": 2, - "name": "Max", - "breed": "unknown", - "fluffiness": 5, - "cuteness": 10 -} -``` - -This endpoint retrieves a specific team. - -### HTTP Request - -`GET https://api.dc01.gamelockerapp.com/teams/<ID>` - -### URL Parameters - -Parameter | Description ---------- | ----------- -ID | The ID of the team to retrieve |
