-
Notifications
You must be signed in to change notification settings - Fork 0
/
group_paths.html
229 lines (202 loc) Β· 11.6 KB
/
group_paths.html
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Group related paths — Tdproto docs documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.svg"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Miscellaneous paths" href="misc_paths.html" />
<link rel="prev" title="Task related paths" href="task_paths.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Tdproto docs
<img src="_static/logo.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="basics.html">Basics</a></li>
<li class="toctree-l1"><a class="reference internal" href="bot_howto.html">How to create bot</a></li>
<li class="toctree-l1"><a class="reference internal" href="team_paths.html">Team related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="chat_paths.html">Chat related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="task_paths.html">Task related paths</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Group related paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc_paths.html">Miscellaneous paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="websocket.html">Websockets documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">Client events</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html#server-events">Server events</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html">Enums index</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#type-aliases">Type aliases</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#json-objects-index">JSON objects index</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#http-queries">HTTP Queries</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Tdproto docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Group related paths</li>
<li class="wy-breadcrumbs-aside">
<a style="color:red;font-size:36px;" href="https://tada-team.github.io/tdproto-docs-ru/group_paths">π·πΊ</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="group-related-paths">
<h1>Group related paths<a class="headerlink" href="#group-related-paths" title="Permalink to this heading">ο</a></h1>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-v4-teams-team_id-groups">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/v4/teams/{team_id}/groups</span></span><a class="headerlink" href="#get--api-v4-teams-team_id-groups" title="Permalink to this definition">ο</a></dt>
<dd><p>Get all groups in the team.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_api_v4_teams__team_id__groups">π Try it!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>team_id</strong> β ID of the team.</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) β True if no error occured.</p></li>
<li><p><strong>result</strong> (<em>array</em>) β List of <a class="reference internal" href="data_index.html#tdmodels-Chat"><span class="std std-ref">Chat</span></a> objects.</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> β No error.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http delete">
<dt class="sig sig-object http" id="delete--api-v4-teams-team_id-groups">
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/v4/teams/{team_id}/groups</span></span><a class="headerlink" href="#delete--api-v4-teams-team_id-groups" title="Permalink to this definition">ο</a></dt>
<dd><p>Delete the group.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/delete_api_v4_teams__team_id__groups">π Try it!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>team_id</strong> β ID of the team.</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) β True if no error occured.</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> β No error.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-v4-teams-team_id-groups-group_id-members">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/v4/teams/{team_id}/groups/{group_id}/members</span></span><a class="headerlink" href="#get--api-v4-teams-team_id-groups-group_id-members" title="Permalink to this definition">ο</a></dt>
<dd><p>Get the list of group members.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_api_v4_teams__team_id__groups__group_id__members">π Try it!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>team_id</strong> β ID of the team.</p></li>
<li><p><strong>group_id</strong> β ID of the group.</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) β True if no error occured.</p></li>
<li><p><strong>result</strong> (<em>array</em>) β List of <a class="reference internal" href="data_index.html#tdmodels-GroupMembership"><span class="std std-ref">GroupMembership</span></a> objects.</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> β No error.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http delete">
<dt class="sig sig-object http" id="delete--api-v4-teams-team_id-groups-group_id-members-contact_id">
<span class="sig-name descname"><span class="pre">DELETE</span> </span><span class="sig-name descname"><span class="pre">/api/v4/teams/{team_id}/groups/{group_id}/members/{contact_id}</span></span><a class="headerlink" href="#delete--api-v4-teams-team_id-groups-group_id-members-contact_id" title="Permalink to this definition">ο</a></dt>
<dd><p>Remove member from the group.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/delete_api_v4_teams__team_id__groups__group_id__members__contact_id_">π Try it!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>team_id</strong> β ID of the team.</p></li>
<li><p><strong>contact_id</strong> β ID of the contact.</p></li>
<li><p><strong>group_id</strong> β ID of the group.</p></li>
</ul>
</dd>
<dt class="field-even">Response JSON Object<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) β True if no error occured.</p></li>
<li><p><strong>result</strong> (<em>object</em>) β The <a class="reference internal" href="data_index.html#tdmodels-GroupMembership"><span class="std std-ref">GroupMembership</span></a> object.</p></li>
</ul>
</dd>
<dt class="field-odd">Status Codes<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> β No error.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="task_paths.html" class="btn btn-neutral float-left" title="Task related paths" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="misc_paths.html" class="btn btn-neutral float-right" title="Miscellaneous paths" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<li><a href="https://github.com/tada-team/tdproto-sphinx/">Project Homepage</a> »</li>
<p>© Copyright .</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>