open-data.html
3.54 KB
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
{% extends "base.html" %}
{% load i18n %}
{% block main-content %}
<div class="col-lg-12">
<h2>{% trans "OpenData - Communities Interlegis" %}</h2>
<p>{% trans "If you are interested in integrating your system with the Colab environment and requires no other data provided by this API, please contact us via the ticketing system (you must be registered in order to create a ticket)." %}</p>
<h3>{% trans "Retrieving data via API" %}</h3>
<p>{% trans "Colab API works through an HTTP/REST always returning JSON objects." %}</p>
<p>
{% trans "The base API URL is" %}:
{% with "/api/colab/" as BASE_API_URL %}
<a href="{{ BASE_API_URL }}">http://colab.interlegis.leg.br{{ BASE_API_URL }}</a>
</p>
<ul class="list-unstyled">
<li>
<p>{% trans "Each model listed below has a resource_uri field available, which is the object's data URI." %}</p>
<p>{% trans "The following list contains the available models to retrieve data" %}:</p>
<ul>
<li>
<strong><a href="{{ BASE_API_URL }}user/">user</a></strong>:
{% trans "Retrieve users with username, institution, role, twitter, facebook, google talk, github, webpage and bio" %}
</li>
<li>
<strong><a href="{{ BASE_API_URL }}emailaddress/">emailaddress</a></strong>:
{% trans "Retrieve emailaddress with user and real_name" %}
</li>
<li>
<strong><a href="{{ BASE_API_URL }}message/">message</a></strong>:
{% trans "Retrieve messages with body, id, received_time and subject" %}
</li>
<li>
<strong><a href="{{ BASE_API_URL }}revision/">revision</a></strong>:
{% trans "Retrieve revisions with author, created, key, message and repository_name" %}
</li>
<li>
<strong><a href="{{ BASE_API_URL }}ticket/">ticket</a></strong>:
{% trans "Retrieve tickets with author, component, created, description, id, keywords, milestone, modified, modified_by, priority, reporter, severity, status, summary and version" %}
</li>
<li>
<strong><a href="{{ BASE_API_URL }}wiki/">wiki</a></strong>:
{% trans "Retrieve wikis with author, created, modified, modified_by, name and wiki_text" %}
</li>
{% endwith %}
</ul>
</li>
</ul>
<ul class="list-unstyled">
<li><h3>{% trans 'Parameters' %}:</h3></li>
<li class="divider"></li>
<li>
<h4><i>limit</i> - {% trans "Results per page" %}</h4>
{% trans "Number of results to be displayed per page." %}
<i>{% trans "Default: 20" %}</i>.
</li>
<li class="divider"></li>
<li>
<h4><i>offset</i> - {% trans "Starts of n element" %}</h4>
{% trans "Where n is the index of the first result to appear in the page." %}
<i>{% trans "Default: 0" %}</i>.
</li>
<li>
<h4><i>fieldname</i> - {% trans "The field name" %}</h4>
{% trans "If you are looking for a specific wiki, and you know the wiki's name, you can filter it as below" %}
<p><i>...{{ BASE_API_URL }}wiki/?name={% trans "WikiName" %}</i></p>
{% trans "You can also filter using Django lookup fields as below" %}
<p><i>...{{ BASE_API_URL }}wiki/?name__startswith={% trans "Wiki" %}</i></p>
<p><i>...{{ BASE_API_URL }}wiki/?name__endswith={% trans "Name" %}</i></p>
<p><i>...{{ BASE_API_URL }}wiki/?name__contains={% trans "Wiki" %}</i></p>
</li>
</ul>
</div>
{% endblock %}