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
|
<% @title = "Application Programming Interface - API" %>
<%= render :partial => 'sidebar' %>
<h1><%=@title %></h1>
<h2> Introduction </h2>
<p>This page explains how programmers can make other websites and software
interact with WhatDoTheyKnow via an "API".
</p>
<p>WhatDoTheyKnow does not have a full API yet, but we are gradually adding
lots of things that are similar in use to an API as they are requested.
</p>
<h2> Linking to new requests </h2>
<p>To encourage your users to make links to a particular public authority, use URLs of the form
<%= link_to new_request_to_body_url(:url_name => "liverpool_city_council") , new_request_to_body_url(:url_name => "liverpool_city_council") %>.
These are the parameters you can add to those URLs, either in the URL or from a form.
<ul>
<li> <strong>title</strong> - default summary of the new request.</li>
<li> <strong>default_letter</strong> - default text of the body of the letter. The salutation (Dear...) and signoff (Yours...) are wrapped round this. </li>
<li> <strong>body</strong> - as an alternative to default_letter, this sets the default entire text of the request, so you can customise the salutation and signoff. </li>
<li> <strong>tags</strong> - space separated list of tags, so you can find and link up any requests made later, e.g. <em>openlylocal spending_id:12345</em>. The : indicates it is a machine tag. The values of machine tags may also include colons, useful for URIs.
</ul>
<h2> RSS (actually, Atom) feeds </h2>
<p>There are Atom feeds throughout the site, which you can use to get updates
and links in XML format.
<p>In particular, search queries, however complicated, all have Atom feeds.
You can do all sorts of things with them, such as query by authority, by file
type, by date range, by status. See the <a href="/search">advanced search
tips</a> for details.
<dl>
|
