Tags¶
Added in version 2.2.0: This resource endpoint.
Resource description¶
The tag resource contains the following fields (currently limited to organisers and reviewers):
Field |
Type |
Description |
---|---|---|
tag |
string |
The actual tag name. |
description |
multi-lingual string |
The description of the tag. |
|
string |
The tag’s colour as hex string. |
Endpoints¶
- GET /api/events/{event}/tags/¶
Returns a list of all tags configured for this event.
Example request:
GET /api/events/sampleconf/tags/ HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "tag": "science", "description": {"en": "Scientific sessions"}, "color": "#00ff00", } ] }
- Parameters:
event – The
slug
field of the event to fetch
- Query Parameters:
page – The page number in case of a multi-page result set, default is 1
- GET /api/events/(event)/tags/{tag}/¶
Returns information on one tag, identified by its tag string.
Example request:
GET /api/events/sampleconf/tags/science HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "tag": "science", "description": {"en": "Scientific sessions"}, "color": "#00ff00", }
- Parameters:
event – The
slug
field of the event to fetchcode – The
tag
field of the tag to fetch
- Status Codes:
200 OK – no error
401 Unauthorized – Authentication failure