public/mailtrain
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #348 from zermelo-software/api_extensions

Browse source 
Add API support for GET /api/subscriptions/:listId
This commit is contained in:
Roger Witzig 2017-11-13 15:25:06 +01:00 • committed by GitHub
commit dca236af23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 54 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

33
routes/api.js
View file

@ -315,6 +315,39 @@ router.post('/delete/:listId', (req, res) => {
});
});
router.get('/subscriptions/:listId', (req, res) => {
let start = parseInt(req.query.start || 0, 10);
let limit = parseInt(req.query.limit || 10000, 10);
lists.getByCid(req.params.listId, (err, list) => {
if (err) {
res.status(500);
return res.json({
error: err.message || err,
data: []
});
}
subscriptions.list(list.id, start, limit, (err, rows, total) => {
if (err) {
res.status(500);
return res.json({
error: err.message || err,
data: []
});
}
res.status(200);
res.json({
data: {
total: total,
start: start,
limit: limit,
subscriptions: rows
}
});
});
});
});
router.post('/field/:listId', (req, res) => {
let input = {};
Object.keys(req.body).forEach(key => {

21
views/users/api.hbs
View file

@ -43,6 +43,27 @@
</ul>
</div>
<h3>GET /api/subscriptions/:listId – {{#translate}}Get list of subscriptions{{/translate}}</h3>
<p>
{{#translate}}Retrieve a list of subscriptions to the list referenced by :listId. All fields of the subscribers will be returned. Note that custom fields will have generated names.{{/translate}}
</p>
<p>
<strong>GET</strong> {{#translate}}arguments{{/translate}}
</p>
<ul>
<li><strong>access_token</strong> – {{#translate}}your personal access token{{/translate}}
<li><strong>start</strong> – {{#translate}}Start position{{/translate}} (<em>{{#translate}}optional, default 0{{/translate}}</em>)</li>
<li><strong>limit</strong> – {{#translate}}limit subscription count in response{{/translate}} (<em>{{#translate}}optional, default 10000{{/translate}}</em>)</li>
</ul>
<p>
<strong>{{#translate}}Example{{/translate}}</strong>
</p>
<pre>curl -XGET '{{serviceUrl}}api/subscriptions/B16uVTdW?access_token={{accessToken}}&limit=10&start=0' </pre>
<h3>POST /api/subscribe/:listId – {{#translate}}Add subscription{{/translate}}</h3>
<p>