/
standard-work-spec-v1.html.md.erb
341 lines (321 loc) · 11.4 KB
/
standard-work-spec-v1.html.md.erb
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
---
title: Standard Work Specifications
summary: Retrieve standard work specification details for home energy upgrades.
url: GET /api/standard-work-specs/spec/v1
---
# <%= current_page.data.title %> <span class="url">(<%= current_page.data.url %>)</span>
<%= current_page.data.summary %>
<ul id="toc"></ul>
## Request URL
<pre>GET /api/standard-work-specs/spec/v1<em>.format?parameters</em></pre>
## Request Parameters
<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th class="doc-parameters-name" scope="col">Parameter</th>
<th class="doc-parameters-required" scope="col">Required</th>
<th class="doc-parameters-value" scope="col">Value</th>
<th class="doc-parameters-description" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th class="doc-parameter-name" scope="row">format</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
<div class="doc-parameter-value-field">
<strong>Options:</strong> <em>json</em>, <em>xml</em>
</div>
</td>
<td class="doc-parameter-description">
<p>The output response format. Given in the URL as the file extension.</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">api_key</th>
<td class="doc-parameter-required">Yes</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>Your developer API key. See <a href="/docs/api-key/">API keys</a> for more information.</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">nid</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>The unique identifier of a standard work specification entry.</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">spec</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>The specification ID for a given specification.</p>
<p><strong>Ex. "Floor Framing—Bay Window" is 3.1302.1 so the parameter is "<em>spec=1.1302.1</em></strong>"</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">ht</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>The unique identifier of a housing type to filter on.</p>
<p><strong>Single Family Homes:</strong> 1, <strong>Multi-Family Homes:</strong> 2, <strong>Manufactured Housing:</strong> 3</p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">section</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>A section identifier. These can be found next to each section in the website navigation and detail pages.</p>
<p><strong>Ex. "Air Sealing" is section 3 so the parameter is "<em>section=3</em>"</strong></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">topic</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>A topic identifier. These can be found next to each topic in the website navigation and detail pages.</p>
<p><strong>Ex. "Attached Garages" is topic 15 so the parameter is "<em>topic=15"</em></strong></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">subtopic</th>
<td class="doc-parameter-required">No</td>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> integer
</div>
<div class="doc-parameter-value-field">
<strong>Default:</strong> None
</div>
</td>
<td class="doc-parameter-description">
<p>A subtopic identifier. These are the last 2 digits of the Subtopic headers. <em>(Must be entered as a 2 digit number)</em></p>
<p><strong>Ex. "Floor Framing" is subtopic 02 under the "Floors" topic under the "Air Sealing" section so the parameter is <em>"subtopic=02"</em></strong></p>
</td>
</tr>
</tbody>
</table>
## Response Fields
<table border="0" cellpadding="0" cellspacing="0" class="doc-parameters">
<thead>
<tr>
<th class="doc-parameters-name" scope="col">Field</th>
<th class="doc-parameters-value" scope="col">Value</th>
<th class="doc-parameters-description" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th class="doc-parameter-name" scope="row">classification</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">
<p>The SWS classification id for the specification.</p>
<p><strong>Ex.</strong> <em>3.1302.1</em></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">title</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">
<p>The title of the specification.</p>
<p><strong>Ex.</strong> <em>Floor Framing—Bay Window</em></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">section</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">
<p>The section the specification belongs to.</p>
<p><strong>Ex.</strong> <em>Air Sealing</em></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">topic</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">
<p>The topic the specification belongs to.</p>
<p><strong>Ex.</strong> <em>Floors</em></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">subtopic</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">
<p>The subtopic the specification belongs to.</p>
<p><strong>Ex.</strong> <em>Floor Framing</em></p>
</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">desired_outcome</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> string
</div>
</td>
<td class="doc-parameter-description">The desired outcome field. May contain HTML.</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">housing_types</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> array
</div>
</td>
<td class="doc-parameter-description">An array of housing type strings that apply to this specification.</td>
</tr>
<tr>
<th class="doc-parameter-name" scope="row">details</th>
<td class="doc-parameter-value">
<div class="doc-parameter-value-field">
<strong>Type:</strong> array
</div>
</td>
<td class="doc-parameter-description">
<p>An array of details that belong to this specification. Each detail contains the following fields:</p>
<ul>
<li><strong>classification:</strong><em>string</em></li>
<li><strong>title:</strong><em>string</em></li>
<li><strong>specification</strong><strong>:</strong><em>string</em></li>
<li><strong>objective:</strong><em>string</em></li>
<li><strong>housing_type</strong><em>:string</em></li>
</ul>
</td>
</tr>
</tbody>
</table>
## Examples
### JSON Output Format
<pre>GET <a href="/api/standard-work-specs/spec/v1.json?api_key=DEMO_KEY">/api/standard-work-specs/spec/v1.json?api_key=DEMO_KEY</a></pre>
```json
[
{
"classification": "3.1602.9",
"title": "Crossover Ducts",
"section": "Air Sealing",
"topic": "Ducts",
"subtopic": "Duct Sealing",
"desired_outcome": "Deliver all air from trunk to trunk without leakage or restriction",
"housing_types": [
"Manufactured Housing"
],
"details": [
{
"objective": "<p>Verify scope of work</p>",
"title": "Work assessment",
"classification": "3.1602.9a",
"specification": "<p>Installer prework assessment will be conducted to determine:</p><ul><li> Location</li><li> Types</li><li> Leakage points</li></ul>",
"housing_type": [
"Manufactured Housing"
]
}
]
}
]
```
### XML Output Format
<pre>GET <a href="/api/standard-work-specs/spec/v1.xml?api_key=DEMO_KEY">/api/standard-work-specs/spec/v1.xml?api_key=DEMO_KEY</a></pre>
```xml
<?xml version="1.0" encoding="utf-8"?>
<result is_array="true">
<item>
<classification type="string"/>
<title type="string"/>
<section type="string"/>
<topic type="string"/>
<subtopic type="string"/>
<desired_outcome type="string"/>
<housing_types is_array="true">
<item type="string"/>
</housing_types>
<details is_array="true">
<item>
<objective type="string"/>
<title type="string"/>
<classification type="string"/>
<specification type="string"/>
<housing_type is_array="true">
<item type="string"/>
</housing_type>
</item>
</details>
</item>
</result>
```
## Rate Limits
[Standard rate limits](/docs/rate-limits) apply. No more than 1,000 requests may be made in any hour
## Errors
[Standard errors](/docs/errors) may be returned.