early-intervention-unit-cost-database/documentation.txt at master · datagovuk-hackcode/early-intervention-unit-cost-database · GitHub

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
Unit Cost Database - MySQL and API

MySQL Database at mysql://unitcostdatabase:unitcostdatabase@toastwaffle.com/unitcostdatabase
PHPMyAdmin at http://www.toastwaffle.com/phpmyadmin
DB Dump and Python SQLAlchemy ORM Classes at http://www.toastwaffle.com/UnitCostDB.tar.gz

Base URL: http://unitcost.toastwaffle.com/api/

Endpoints

agency/

    List all agencies

    Parameters:
     * search - Search term over agency name
     * level - Agency level

agency/<int:id>

    Get agency with specific ID

agency/<int:id>/children

    Get children of agency with specific ID

agency/<int:id>/entries

    Get entries related to agency with specific ID

category/

    List all categories

    Parameters:
     * search - Search term over category name

category/<int:id>

    Get category with specific ID

category/<int:id>/subcategories

    Get children of category with specific ID

category/<int:id>/entries

    Get entries related to category with specific ID

subcategory/

    List all subcategories

    Parameters:
     * search - Search term over subcategory name

subcategory/<int:id>

    Get subcategory with specific ID

subcategory/<int:id>/parents

    Get children of subcategory with specific ID

subcategory/<int:id>/entries

    Get entries related to subcategory with specific ID

unit/

    List all units

    Parameters:
     * search - Search term over unit name

unit/<int:id>

    Get unit with specific ID

unit/<int:id>/entries

    Get entries related to unit with specific ID

entry/

    List all entries

    Parameters:
     * search - Search term over entry detail, source, comment

entry/<int:id>

    Get entry with specific ID

gdp/

    Get all GDP info

gdp/year/<int:year>/

    Get GDP info for a specific year

gdp/cumulative/start/<int:startyear>/end/<int:endyear>/

    Get cumulative GDP change between 2 years

    (Use for calculating cost of old entries in a particular year)

gdp/cumulative/start/<int:startyear>/

    Get cumulative GDP change from one particular year to all years

    (Use for calculating cost series of entries from a particular year)

gdp/cumulative/end/<int:endyear>/

    Get cumulative GDP change from all years to one particular year

    (Use for calculating cost of old entries in a particular year)