blob: f3808054f6faaaa1bb870ef696302ff413a57976 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
|
