blob: c0fa39d1e7c31d5463145f5bc47ea7fd01a296dd (
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
.. _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 Default Description
================= ============== =============================================================
filter[teamNames] none Filters by team name. Usage: filter[teamNames]=team1
filter[teamIds] none 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
**Javascript:**
.. code-block:: javascript
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
}
Links (Coming Soon!)
---------------------------
This endpoint checks to see if a link object exists for a given code.
**HTTP Request**
| ``GET https://api.dc01.gamelockerapp.com/link``
**Javascript:**
.. code-block:: javascript
curl -XPOST "https://api.dc01.gamelockerapp.com/shards/na/link/{player_id}" \
-H "Authorization: Bearer <api-key>" \
-H "Accept: application/vnd.api+json"
Post a Link
---------------------------
This endpoint creates a PlayerLink object if the verification code matches the one provided by the game.
**HTTP Request**
| ``POST https://api.dc01.gamelockerapp.com/link/{player_id}``
**Javascript:**
.. code-block:: javascript
curl -XPOST "https://api.dc01.gamelockerapp.com/shards/na/link/{player_id}" \
-H "Authorization: Bearer <api-key>" \
-H "Accept: application/vnd.api+json"
Player Link
----------------
**Javascript:**
.. code-block:: javascript
{
"attributes": {
"playerId": "fb374a7b-78be-4fcc-83ed-6a532a8a6f55",
"shardId": "na",
"titleId": "semc-vainglory"
},
"id": "2454e5ac-0a69-4468-ad12-8616f066e817",
"type": "playerLink"
}
.. toctree::
:maxdepth: 2
|
