-
Notifications
You must be signed in to change notification settings - Fork 11
/
Postman-guidelines.json
254 lines (254 loc) · 9.65 KB
/
Postman-guidelines.json
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
{
"info": {
"name": "Carbonfootprint API",
"_postman_id": "63ab83b6-854f-95b9-07f4-45789b0c3a9f",
"description": "Collections of all the carbonfootprint API endpoints and its documentation.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Transport",
"description": "",
"item": [
{
"name": "https://carbonhub.org/v1/flight",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": "{{key}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"origin\": \"DEL\",\n \"destination\": \"JFK\",\n \"type\": \"international\",\n \"model\": \"A380\",\n \"passengers\": 840\n}"
},
"url": {
"raw": "https://carbonhub.org/v1/flight",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"flight"
]
},
"description": "Find Emissions for a flight between two airports. Only IATA (https://en.wikipedia.org/wiki/IATA_airport_code) Airport Codes are supported.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
},
{
"name": "https://carbonhub.org/v1/vehicle",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"Petrol\",\n \"origin\": \"Bhubaneswar\",\n \"destination\": \"Cuttack\",\n \"mileage\": 50,\n \"mileage_unit\": \"km/l\"\n}\n"
},
"url": {
"raw": "https://carbonhub.org/v1/vehicle",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"vehicle"
]
},
"description": "This route enables you to find GHG emissions for a number of fuels.The distance is calculated using Microsoft Bing Maps Distant Matrix API (https://docs.microsoft.com/en-us/bingmaps/rest-services/routes/calculate-a-distance-matrix). The fuels that we currently support are listed in /Source/Core/core/resources/fuels.json.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
},
{
"name": "https://carbonhub.org/v1/trains",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\":\"railcars\",\n \"origin\":\"Bhubaneswar\",\n \"destination\":\"Delhi\",\n \"passengers\":10\n}"
},
"url": {
"raw": "https://carbonhub.org/v1/trains",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"trains"
]
},
"description": "This route enables you to find GHG emissions for a number of train types for a certain route.The distance is calculated using Microsoft Bing Maps Distant Matrix API (https://docs.microsoft.com/en-us/bingmaps/rest-services/routes/calculate-a-distance-matrix). The trains that we currently support are listed in /raw_data/trains.json.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
}
]
},
{
"name": "https://carbonhub.org/v1/appliances",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"appliance\":\"Water heater\",\n \"type\":\"instantaneous\",\n \"region\":\"India\",\n \"quantity\":1,\n \"runnning_time\":3\n}"
},
"url": {
"raw": "https://carbonhub.org/v1/appliances",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"appliances"
]
},
"description": "This route enables you to find GHG emissions for a number of appliance types for a specific quantity and running time. The emissions are calculated from the electricity based emissions on a particular region.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
},
{
"name": "https://carbonhub.org/v1/poultry",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": "{{key}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\":\"Broiler chicken\",\n \"region\":\"British columbia\",\n \"quantity\":3\n}"
},
"url": {
"raw": "https://carbonhub.org/v1/poultry",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"poultry"
]
},
"description": "- This route enables you to find GHG emissions for different type of Poutry meat production. In this we consider the factors like Production emission, Water loss factor, Moisture loss factor, Post-farmgate emissions in different conditions according to region in which they are found.\n- Types of poultry is in /raw_data/poultry.json\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
},
{
"name": "https://carbonhub.org/v1/emissions",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "[{\n \"item\": \"electricity\",\n \"region\": \"india\",\n \"unit\": \"kWh\",\n \"quantity\": 1.9999\n},\n{\n \"item\": \"airplane model A380\",\n \"unit\": \"nm\",\n \"quantity\": 125\n},\n{\n \"item\":\"fuelPetrol\",\n \"quantity\": 2,\n \"unit\": \"L\"\n},\n{\n \"item\":\"railcars\",\n \"region\":\"Default\",\n \"quantity\": 1000,\n \"unit\": \"kg/km\",\n \"multiply\": 3\n},\n{\n \"item\":\"Cherry\",\n \"region\":\"Default\",\n \"quantity\": 1,\n \"unit\": \"year\"\n},\n{\n \"item\":\"Air conditioner large\",\n \"region\":\"Africa\",\n \"unit\":\"kWh\",\n \"quantity\":1,\n \"multiply\":8\n}\n]\n"
},
"url": {
"raw": "https://carbonhub.org/v1/emissions",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"emissions"
]
},
"description": "GHG EMISSIONS\n\n1. Electricity\n - The emission route can be requested to find emission for any country for per kilowatt of electricity consumed. It can also deliver components of emission like generation and transmission & dissipation when queried with item names generation and td respectively.The data source for this is here. The region that is unavailable results in returning the emission for the Default region which is calculated as a average of the whole data.\n\n2. Airplane Fuel\n - Airplane fuel converts the distance flown by a particular air plane to corresponing CO2 emission.\n\n3. Vehicle Fuel\n - Emission route can be requested with fuel quantity and type and unit , to return the GHG emission generated on the consumption of the same.The fuels that we currently support are listed in Source/Core/core/resources/fuels.json\n \n4. Trains\n - Emission route can provide you with the emission generated from a train journey, provided with the distance of the journey.Here the item is the the train type and multiply signifies the number of passengers.\n \n5. Trees\n - Emission route can be requested with tree name and the number of years to find out the CO2 absorption from it per year.The trees that we currently support are listed /Source/Core/core/resources/trees.json.\n \n6. Appliances\n - Emission route can be requested with a appliance name and the number of units and no of hours to find out the CO2 emission for the running time.The appliances that we currently support are listed /raw_data/appliances.json.\n\nUSE ONLY ONE EXAMPLE GIVEN IN THE BODY AT A TIME.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
},
{
"name": "https://carbonhub.org/v1/quantity",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "access-key",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n \"item\": \"lamp\",\n \"region\": \"ohio\",\n \"emission\": 91\n}"
},
"url": {
"raw": "https://carbonhub.org/v1/quantity",
"protocol": "https",
"host": [
"carbonhub",
"xyz"
],
"path": [
"v1",
"quantity"
]
},
"description": "This route is can be used to retrieve the quantity of a certain element provided the CO2 emission for the specific item is already known.\n\nYou need to sepcify your 'access-key' (which you got from https://carbonhub.org/) variable in the header."
},
"response": []
}
]
}