Skip to content

Commit 1a48173

Browse files
xonecoxoneco
authored
Merge pull request #4 from uclapi/namie_mcroomname
name parameter changes to roomname
2 parents 38272f4 + 8d82692 commit 1a48173

2 files changed

Lines changed: 18 additions & 24 deletions

File tree

‎build/index.html‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ <h3 id="query-parameters">Query Parameters</h3>
172172
<td>The room id (not to be confused with the room name).</td>
173173
</tr>
174174
<tr>
175-
<td><code class="prettyprint">name</code></td>
175+
<td><code class="prettyprint">roomname</code></td>
176176
<td><code class="prettyprint">Torrington (1-19) 433</code></td>
177177
<td>Optional</td>
178178
<td>The name of the room. It often includes the name of the site (building) as well.</td>
@@ -208,7 +208,7 @@ <h3 id="response">Response</h3>
208208
</span><span class="s2">"ok"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
209209
</span><span class="s2">"rooms"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
210210
</span><span class="p">{</span><span class="w">
211-
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wilkins Building (Main Building) Portico"</span><span class="p">,</span><span class="w">
211+
</span><span class="s2">"roomname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wilkins Building (Main Building) Portico"</span><span class="p">,</span><span class="w">
212212
</span><span class="s2">"roomid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Z4"</span><span class="p">,</span><span class="w">
213213
</span><span class="s2">"siteid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"005"</span><span class="p">,</span><span class="w">
214214
</span><span class="s2">"sitename"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Main Building"</span><span class="p">,</span><span class="w">
@@ -238,7 +238,7 @@ <h3 id="response">Response</h3>
238238
</tr>
239239
</thead><tbody>
240240
<tr>
241-
<td><code class="prettyprint">name</code></td>
241+
<td><code class="prettyprint">roomname</code></td>
242242
<td><code class="prettyprint">Wilkins Building (Main Building) Portico</code></td>
243243
<td>The name of the room. It often includes the name of the site (building) as well.</td>
244244
</tr>
@@ -391,9 +391,8 @@ <h3 id="query-parameters">Query Parameters</h3>
391391
</tbody></table>
392392

393393
<h3 id="response">Response</h3>
394-
<pre class="highlight json"><code><span class="p">{</span><span class="w">
395-
</span><span class="s2">"ok"</span><span class="p">:</span><span class="kc">true</span><span class="p">,</span><span class="w">
396-
</span><span class="s2">"bookings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
394+
<pre class="highlight json"><code><span class="p">{</span><span class="w">
395+
</span><span class="s2">"ok"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
397396
</span><span class="s2">"next_page_exists"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
398397
</span><span class="s2">"page_token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"6hb14hXjRV"</span><span class="p">,</span><span class="w">
399398
</span><span class="s2">"count"</span><span class="p">:</span><span class="w"> </span><span class="mi">1197</span><span class="p">,</span><span class="w">
@@ -414,8 +413,8 @@ <h3 id="response">Response</h3>
414413
</span><span class="p">},</span><span class="w">
415414
</span><span class="err">...</span><span class="w">
416415
</span><span class="p">]</span><span class="w">
417-
</span><span class="p">}</span><span class="w">
418416
</span><span class="p">}</span><span class="w">
417+
419418
</span></code></pre>
420419
<table><thead>
421420
<tr>
@@ -555,13 +554,12 @@ <h3 id="query-parameters">Query Parameters</h3>
555554

556555
<h3 id="response">Response</h3>
557556
<pre class="highlight json"><code><span class="p">{</span><span class="w">
558-
</span><span class="s2">"ok"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
559-
</span><span class="s2">"bookings"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
557+
</span><span class="s2">"ok"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
560558
</span><span class="s2">"page_token"</span><span class="p">:</span><span class="w"> </span><span class="s2">"wmCUiJgItq"</span><span class="p">,</span><span class="w">
561559
</span><span class="s2">"next_page_exists"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
562560
</span><span class="s2">"bookings"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
563561
</span><span class="p">{</span><span class="w">
564-
</span><span class="s2">"room"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Christopher Ingold Building XLG2 Auditorium"</span><span class="p">,</span><span class="w">
562+
</span><span class="s2">"roomname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Christopher Ingold Building XLG2 Auditorium"</span><span class="p">,</span><span class="w">
565563
</span><span class="s2">"slotid"</span><span class="p">:</span><span class="w"> </span><span class="mi">733044</span><span class="p">,</span><span class="w">
566564
</span><span class="s2">"siteid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"067"</span><span class="p">,</span><span class="w">
567565
</span><span class="s2">"start_time"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-03-20T13:00:00+00:00"</span><span class="p">,</span><span class="w">
@@ -572,9 +570,8 @@ <h3 id="response">Response</h3>
572570
</span><span class="s2">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
573571
</span><span class="s2">"contact"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Dr Mark Roberts"</span><span class="w">
574572
</span><span class="p">},</span><span class="w">
575-
</span><span class="err">...</span><span class="w">
573+
</span><span class="err">...</span><span class="w">
576574
</span><span class="p">]</span><span class="w">
577-
</span><span class="p">}</span><span class="w">
578575
</span><span class="p">}</span><span class="w">
579576
</span></code></pre>
580577
<p>The response to a paginated request is identical to that of a regular request, except that no <code class="prettyprint">count</code> field is provided.</p>

‎source/index.html.md‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Parameter | Example | Required | Description
5858
--------- | ---------- | ----------- | -----------
5959
`token` | `uclapi-5d58c3c4e6bf9c-c2910ad3b6e054-7ef60f44f1c14f-a05147bfd17fdb` | Required | Authentication token
6060
`roomid` | `433` | Optional | The room id (not to be confused with the room name).
61-
`name` | `Torrington (1-19) 433`| Optional | The name of the room. It often includes the name of the site (building) as well.
61+
`roomname` | `Torrington (1-19) 433`| Optional | The name of the room. It often includes the name of the site (building) as well.
6262
`siteid` | `086`| Optional | Every room is inside a site (building). All sites have ids.
6363
`sitename` | `Torrington Place, 1-19`| Optional | Every site (building) has a name. In some cases this is contained in the room name as well.
6464
`classification` | `CR`| Optional | The type of room. `LT` = Lecture Theatre, `CR` = Classroom, `SS` = Social Space, `PC1` = Public Cluster
@@ -71,7 +71,7 @@ Parameter | Example | Required | Description
7171
"ok": true,
7272
"rooms": [
7373
{
74-
"name": "Wilkins Building (Main Building) Portico",
74+
"roomname": "Wilkins Building (Main Building) Portico",
7575
"roomid": "Z4",
7676
"siteid": "005",
7777
"sitename": "Main Building",
@@ -96,7 +96,7 @@ The room field contains a list of rooms that match your query. If no filters are
9696

9797
Room Property | Example | Description
9898
--------- | ---------- | -----------
99-
`name` | `Wilkins Building (Main Building) Portico` | The name of the room. It often includes the name of the site (building) as well.
99+
`roomname` | `Wilkins Building (Main Building) Portico` | The name of the room. It often includes the name of the site (building) as well.
100100
`roomid` | `Z4` | The room id (not to be confused with the room name)
101101
`siteid` | `005`| Every room is inside a site (building). All sites have ids.
102102
`sitename` | `Main Building` | The name of the site (building).
@@ -167,9 +167,8 @@ results_per_page | `50` | Optional | Number of bookings returned per page. Maxim
167167

168168

169169
```json
170-
{
171-
"ok":true,
172-
"bookings": {
170+
{
171+
"ok": true,
173172
"next_page_exists": true,
174173
"page_token": "6hb14hXjRV",
175174
"count": 1197,
@@ -190,8 +189,8 @@ results_per_page | `50` | Optional | Number of bookings returned per page. Maxim
190189
},
191190
...
192191
]
193-
}
194192
}
193+
195194
```
196195

197196

@@ -262,13 +261,12 @@ Parameter | Example | Required | Description
262261

263262
```json
264263
{
265-
"ok": true,
266-
"bookings": {
264+
"ok": true,
267265
"page_token": "wmCUiJgItq",
268266
"next_page_exists": true,
269267
"bookings": [
270268
{
271-
"room": "Christopher Ingold Building XLG2 Auditorium",
269+
"roomname": "Christopher Ingold Building XLG2 Auditorium",
272270
"slotid": 733044,
273271
"siteid": "067",
274272
"start_time": "2017-03-20T13:00:00+00:00",
@@ -279,9 +277,8 @@ Parameter | Example | Required | Description
279277
"phone": "",
280278
"contact": "Dr Mark Roberts"
281279
},
282-
...
280+
...
283281
]
284-
}
285282
}
286283
```
287284

0 commit comments

Comments
 (0)