-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
896 lines (858 loc) · 127 KB
/
index.html
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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Lamps API Documentation</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');@import url('https://fonts.googleapis.com/css?family=Roboto:100,400,700|Source+Code+Pro');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}.hljs-comment{color:#969896}.css .hljs-class,.css .hljs-id,.css .hljs-pseudo,.hljs-attribute,.hljs-regexp,.hljs-tag,.hljs-variable,.html .hljs-doctype,.ruby .hljs-constant,.xml .hljs-doctype,.xml .hljs-pi,.xml .hljs-tag .hljs-title{color:#77A619}.hljs-literal{color:#A69819}.hljs-built_in,.hljs-constant,.hljs-number,.hljs-params,.hljs-pragma,.hljs-preprocessor{color:#1B88B3}.css .hljs-rule .hljs-attribute,.ruby .hljs-class .hljs-title{color:#A37518}.hljs-header,.hljs-inheritance,.hljs-name,.hljs-string,.hljs-value,.ruby .hljs-symbol,.xml .hljs-cdata{color:inherit}.coffeescript .hljs-title,.css .hljs-hexcolor,.hljs-function,.hljs-title,.javascript .hljs-title,.perl .hljs-sub,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword{color:#A63A4A}.hljs-keyword,.javascript .hljs-function{color:#A69819}.hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .css,.xml .hljs-cdata,.xml .javascript,.xml .vbscript{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#C1EF65}.right .hljs-literal{color:#EBDE68}.right .hljs-built_in,.right .hljs-constant,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#77BCD7}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:inherit}.right .coffeescript .hljs-title,.right .css .hljs-hexcolor,.right .hljs-function,.right .hljs-title,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#f099a6}.right .hljs-keyword,.right .javascript .hljs-function{color:#EBDE68}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:#4c555a;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid transparent;margin-bottom:12px}h1,h2,h3,h4,h5{color:#292e31;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:100 36px 'Roboto',Helvetica,sans-serif;font-size:36px}h2{font:100 36px 'Roboto',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#0099e5;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(76,85,90,0) 20%, rgba(76,85,90,0.2) 48%, rgba(221,228,232,0.2) 48%, rgba(221,228,232,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(76,85,90,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:3px;overflow:auto}pre code{color:#4c555a;background-color:transparent;padding:0;border:none}code{color:#b93d6a;background-color:#f5f5f5;font:13px / 19.5px 'Source Code Pro',Menlo,monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:100 36px 'Roboto',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:#4c555a;background-color:#ebf7fd;border-left:4px solid #0099e5}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#0099e5}.warning{color:#4c555a;background-color:#faf0f4;border-left:4px solid #B82E5F}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#B82E5F}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:#4c555a;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:underline;background-color:transparent;border-left:2px solid transparent}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(76,85,90,0.7);padding:8px 12px;border-top:1px solid transparent;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:underline;background-color:transparent;border-left:2px solid transparent}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:black;background-color:transparent;border-radius:10px;margin:-2px -8px -2px 0}.badge.get{color:#fff;background-color:#ddf1fc}.badge.head{color:#fff;background-color:#ddf1fc}.badge.options{color:#fff;background-color:#ddf1fc}.badge.put{color:#fff;background-color:#f7f2c3}.badge.patch{color:#fff;background-color:#f7f2c3}.badge.post{color:#fff;background-color:#e4f2c8}.badge.delete{color:#fff;background-color:#f2d8e1}.collapse-button{float:right}.collapse-button .close{display:none;color:#0099e5;cursor:pointer}.collapse-button .open{color:#0099e5;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:15%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:15%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:48%;padding-right:12px}.right{box-sizing:border-box;float:right;width:52%;padding-left:12px}.right a{color:#0099e5}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:#dde4e8}.right pre{background-color:#272B2D;border:1px solid #272B2D}.right pre code{color:#D0D0D0}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#8ab82e}.definition .method.put{color:#b8aa2e}.definition .method.patch{color:#b8aa2e}.definition .method.delete{color:#b82e5f}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:3px}.example-names .tab-button{cursor:pointer;color:#4c555a;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#424648}.right .example-names .tab-button{color:#dde4e8;border:1px solid #6C6F71;border-radius:3px}.right .example-names .tab-button.active{background-color:#5a6063}#nav-background{position:fixed;left:0;top:0;bottom:0;width:15%;padding-right:14.4px;background-color:#fafcfc;border-right:1px solid #f0f4f7;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:52%;background-color:#2d3134;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:52%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(76,85,90,0.5);background-color:transparent;text-decoration:none !important;border-top:1px solid transparent;border-left:1px solid transparent;border-right:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px 12px 12px 0;margin-bottom:12px;background-color:transparent;border:1px solid transparent;border-radius:3px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px 12px 12px 0;margin:0 0 12px 0;background-color:transparent;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid transparent}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:3px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:2px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#0099e5}.action h4.action-heading .method.head{color:#fff;background-color:#0099e5}.action h4.action-heading .method.options{color:#fff;background-color:#0099e5}.action h4.action-heading .method.put{color:#fff;background-color:#b1a74e}.action h4.action-heading .method.patch{color:#fff;background-color:#b1a74e}.action h4.action-heading .method.post{color:#fff;background-color:#85a546}.action h4.action-heading .method.delete{color:#fff;background-color:#c14a74}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid transparent;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#ddf1fc}.action.get h4.action-heading{color:#0099e5;background:#ddf1fc;border-bottom-color:#ddf1fc}.action.head{border-color:#ddf1fc}.action.head h4.action-heading{color:#0099e5;background:#ddf1fc;border-bottom-color:#ddf1fc}.action.options{border-color:#ddf1fc}.action.options h4.action-heading{color:#0099e5;background:#ddf1fc;border-bottom-color:#ddf1fc}.action.post{border-color:#e4f2c8}.action.post h4.action-heading{color:#85a546;background:#e4f2c8;border-bottom-color:#e4f2c8}.action.put{border-color:#f7f2c3}.action.put h4.action-heading{color:#b1a74e;background:#f7f2c3;border-bottom-color:#f7f2c3}.action.patch{border-color:#f7f2c3}.action.patch h4.action-heading{color:#b1a74e;background:#f7f2c3;border-bottom-color:#f7f2c3}.action.delete{border-color:#f2d8e1}.action.delete h4.action-heading{color:#c14a74;background:#f2d8e1;border-bottom-color:#f2d8e1}</style></head><body class="preload"><div id="nav-background"></div><div class="container-fluid triple"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#top">Overview</a></div><div class="collapse-content"><ul><li><a href="#header-allowed-https-requests-">Allowed HTTPs requests:</a></li><li><a href="#header-description-of-usual-server-responses-">Description Of Usual Server Responses:</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#lamp">Lamp</a></div><div class="collapse-content"><ul><li><a href="#lamp-lamp-collection">Lamp Collection</a><ul><li><a href="#lamp-lamp-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all lamps</a></li><li><a href="#lamp-lamp-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Lamp</a></li></ul></li><li><a href="#lamp-lamp">Lamp</a><ul><li><a href="#lamp-lamp-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Lamp</a></li><li><a href="#lamp-lamp-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Lamp</a></li><li><a href="#lamp-lamp-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Lamp</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#place">Place</a></div><div class="collapse-content"><ul><li><a href="#place-place-collection">Place Collection</a><ul><li><a href="#place-place-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all places</a></li><li><a href="#place-place-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Place</a></li></ul></li><li><a href="#place-place">Place</a><ul><li><a href="#place-place-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Place</a></li><li><a href="#place-place-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Place</a></li><li><a href="#place-place-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Place</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#count">Count</a></div><div class="collapse-content"><ul><li><a href="#count-count-collection">Count Collection</a><ul><li><a href="#count-count-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all counts</a></li><li><a href="#count-count-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Count</a></li></ul></li><li><a href="#count-count">Count</a><ul><li><a href="#count-count-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Count</a></li><li><a href="#count-count-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Count</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#state">State</a></div><div class="collapse-content"><ul><li><a href="#state-state-collection">State Collection</a><ul><li><a href="#state-state-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all states</a></li><li><a href="#state-state-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a State</a></li></ul></li><li><a href="#state-state">State</a><ul><li><a href="#state-state-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a State</a></li><li><a href="#state-state-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a State</a></li><li><a href="#state-state-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a State</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#mcc">Mcc</a></div><div class="collapse-content"><ul><li><a href="#mcc-mcc-collection">Mcc Collection</a><ul><li><a href="#mcc-mcc-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all mcc</a></li><li><a href="#mcc-mcc-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Mcc</a></li></ul></li><li><a href="#mcc-mcc">Mcc</a><ul><li><a href="#mcc-mcc-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Mcc</a></li><li><a href="#mcc-mcc-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Mcc</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#rules">Rules</a></div><div class="collapse-content"><ul><li><a href="#rules-rules-collection">Rules Collection</a><ul><li><a href="#rules-rules-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all rules</a></li><li><a href="#rules-rules-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Rules</a></li></ul></li><li><a href="#rules-rules">Rules</a><ul><li><a href="#rules-rules-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Rules</a></li><li><a href="#rules-rules-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Rules</a></li><li><a href="#rules-rules-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Rules</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#comments">Comments</a></div><div class="collapse-content"><ul><li><a href="#comments-comments-collection">Comments Collection</a><ul><li><a href="#comments-comments-collection-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>List all comments</a></li><li><a href="#comments-comments-collection-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a Comments</a></li></ul></li><li><a href="#comments-comments">Comments</a><ul><li><a href="#comments-comments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Retrieve a Comments</a></li><li><a href="#comments-comments-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Update a Comments</a></li><li><a href="#comments-comments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a Comments</a></li></ul></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="https://mosquitokiller.csie.ncku.edu.tw/apis">https://mosquitokiller.csie.ncku.edu.tw/apis</a></p></nav><div class="content"><div id="right-panel-background"></div><div class="middle"><header><h1 id="top">Lamps API Documentation</h1></header></div><div class="right"><h5>API Endpoint</h5><a href="https://mosquitokiller.csie.ncku.edu.tw/apis">https://mosquitokiller.csie.ncku.edu.tw/apis</a></div><div class="middle"><p>Lamps is a API allowing administrators to view counts and mcc in them.</p>
<h1 id="header-allowed-https-requests-">Allowed HTTPs requests: <a class="permalink" href="#header-allowed-https-requests-" aria-hidden="true">¶</a></h1>
<pre>
PUT : To create resource
POST : Update resource
GET : Get a resource or list of resources
DELETE : To delete resource
</pre>
<h1 id="header-description-of-usual-server-responses-">Description Of Usual Server Responses: <a class="permalink" href="#header-description-of-usual-server-responses-" aria-hidden="true">¶</a></h1>
<ul>
<li>
<p>200 <code>OK</code> - the request was successful (some API calls may return 201 instead).</p>
</li>
<li>
<p>201 <code>Created</code> - the request was successful and a resource was created.</p>
</li>
<li>
<p>204 <code>No Content</code> - the request was successful but there is no representation to return (i.e. the response is empty).</p>
</li>
<li>
<p>400 <code>Bad Request</code> - the request could not be understood or was missing required parameters.</p>
</li>
<li>
<p>401 <code>Unauthorized</code> - authentication failed or user doesn’t have permissions for requested operation.</p>
</li>
<li>
<p>403 <code>Forbidden</code> - access denied.</p>
</li>
<li>
<p>404 <code>Not Found</code> - resource was not found.</p>
</li>
</ul>
</div><div class="middle"><section id="lamp" class="resource-group"><h2 class="group-heading">Lamp <a href="#lamp" class="permalink">¶</a></h2><p>Represents Lamp Details</p>
<hr>
<p><strong>Lamp attributes:</strong></p>
<ul>
<li>
<p>lamp_id <code>(String)</code> : unique identifier.</p>
</li>
<li>
<p>lamp_hash_id <code>(String)</code> : Hash identifier.</p>
</li>
<li>
<p>lamp_location <code>([Number])</code> : Lamp location.</p>
</li>
<li>
<p>lamp_deployed_date <code>(Date)</code> : optional.</p>
</li>
<li>
<p>lamp_wifi_ssid <code>(String)</code> : optional .</p>
</li>
<li>
<p>lamp_wifi_password <code>(String)</code> : optional .</p>
</li>
<li>
<p>place_id <code>(Number)</code> : deploy place id .</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
<li>
<p>updated_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="lamp-lamp-collection" class="resource"><h3 class="resource-heading">Lamp Collection <a href="#lamp-lamp-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/lamps</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[<span class="hljs-number">120.19151248216</span>, <span class="hljs-number">22.9997144678771</span>]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}, {
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST02"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[<span class="hljs-number">120.193272644465</span>, <span class="hljs-number">22.9963046536379</span>]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="lamp-lamp-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all lamps</div><a href="#lamp-lamp-collection-get" class="method get">GET</a><code class="uri">/lamps</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/lamps</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST02"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[
<span class="hljs-number">120</span>,
<span class="hljs-number">22</span>
]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_wifi_ssid</span>": <span class="hljs-value"><span class="hljs-string">"ssid"</span></span>,
"<span class="hljs-attribute">lamp_wifi_password</span>": <span class="hljs-value"><span class="hljs-string">"sspw"</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/lamps/TEST02</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST02"</span></span>,
"<span class="hljs-attribute">lamp_hash_id</span>": <span class="hljs-value"><span class="hljs-string">"2345"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[
<span class="hljs-number">120</span>,
<span class="hljs-number">22</span>
]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_wifi_ssid</span>": <span class="hljs-value"><span class="hljs-string">"ssid"</span></span>,
"<span class="hljs-attribute">lamp_wifi_password</span>": <span class="hljs-value"><span class="hljs-string">"sspw"</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="lamp-lamp-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Lamp</div><a href="#lamp-lamp-collection-post" class="method post">POST</a><code class="uri">/lamps</code></h4></div></div><hr class="split"><div class="middle"><div id="lamp-lamp" class="resource"><h3 class="resource-heading">Lamp <a href="#lamp-lamp" class="permalink">¶</a></h3><p>A single Lamp object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/lamps/<span class="hljs-attribute" title="id">TEST01</span>?<span class="hljs-attribute">key=</span><span class="hljs-literal">hash</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[<span class="hljs-number">120.19151248216</span>, <span class="hljs-number">22.9997144678771</span>]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="lamp-lamp-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Lamp</div><a href="#lamp-lamp-get" class="method get">GET</a><code class="uri">/lamps/{id}{?key}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>String</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>TEST01</span></span><p><code>id</code> of the Lamp to perform action with.</p>
</dd><dt>key</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>hash</span></span><p>use ‘?key=hash’ <= Query by <code>lamp_hash_id</code> pre 6 char</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/lamps/<span class="hljs-attribute" title="id">TEST01</span>?<span class="hljs-attribute">key=</span><span class="hljs-literal">hash</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[<span class="hljs-number">120</span>,<span class="hljs-number">22</span>]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_wifi_ssid</span>": <span class="hljs-value"><span class="hljs-string">"ssid"</span></span>,
"<span class="hljs-attribute">lamp_wifi_password</span>": <span class="hljs-value"><span class="hljs-string">"sspw"</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_hash_id</span>": <span class="hljs-value"><span class="hljs-string">"2345"</span></span>,
"<span class="hljs-attribute">lamp_location</span>": <span class="hljs-value">[
<span class="hljs-number">120</span>,
<span class="hljs-number">22</span>
]</span>,
"<span class="hljs-attribute">lamp_deployed_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_wifi_ssid</span>": <span class="hljs-value"><span class="hljs-string">"ssid"</span></span>,
"<span class="hljs-attribute">lamp_wifi_password</span>": <span class="hljs-value"><span class="hljs-string">"sspw"</span></span>,
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="lamp-lamp-put" class="action put"><h4 class="action-heading"><div class="name">Update a Lamp</div><a href="#lamp-lamp-put" class="method put">PUT</a><code class="uri">/lamps/{id}{?key}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>String</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>TEST01</span></span><p><code>id</code> of the Lamp to perform action with.</p>
</dd><dt>key</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>hash</span></span><p>use ‘?key=hash’ <= Query by <code>lamp_hash_id</code> pre 6 char</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/lamps/<span class="hljs-attribute" title="id">TEST01</span>?<span class="hljs-attribute">key=</span><span class="hljs-literal">hash</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="lamp-lamp-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Lamp</div><a href="#lamp-lamp-delete" class="method delete">DELETE</a><code class="uri">/lamps/{id}{?key}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>String</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>TEST01</span></span><p><code>id</code> of the Lamp to perform action with.</p>
</dd><dt>key</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>hash</span></span><p>use ‘?key=hash’ <= Query by <code>lamp_hash_id</code> pre 6 char</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="place" class="resource-group"><h2 class="group-heading">Place <a href="#place" class="permalink">¶</a></h2><p>Represents Place Details</p>
<hr>
<p><strong>Place attributes:</strong></p>
<ul>
<li>
<p>place_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>place_name <code>(String(25))</code> : Require.</p>
</li>
<li>
<p>place_address <code>(String(50))</code> : Require.</p>
</li>
<li>
<p>place_contact_person <code>(String(10))</code> : optional.</p>
</li>
<li>
<p>place_phone <code>(String(25))</code> : optional .</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
<li>
<p>updated_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="place-place-collection" class="resource"><h3 class="resource-heading">Place Collection <a href="#place-place-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/places</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"成大幼兒園"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"張先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>},
{
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"NETDB"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"楊先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span>
</span>}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="place-place-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all places</div><a href="#place-place-collection-get" class="method get">GET</a><code class="uri">/places</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/places</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"資訊系館一樓"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"楊先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/places/3</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"資訊系館一樓"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"楊先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="place-place-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Place</div><a href="#place-place-collection-post" class="method post">POST</a><code class="uri">/places</code></h4></div></div><hr class="split"><div class="middle"><div id="place-place" class="resource"><h3 class="resource-heading">Place <a href="#place-place" class="permalink">¶</a></h3><p>A single Place object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/places/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"成大幼兒園"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"張先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="place-place-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Place</div><a href="#place-place-get" class="method get">GET</a><code class="uri">/places/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/places/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"成大商家"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"林先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">place_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">place_name</span>": <span class="hljs-value"><span class="hljs-string">"成大商家"</span></span>,
"<span class="hljs-attribute">place_address</span>": <span class="hljs-value"><span class="hljs-string">"台南市東區大學路1號"</span></span>,
"<span class="hljs-attribute">place_contact_person</span>": <span class="hljs-value"><span class="hljs-string">"林先生"</span></span>,
"<span class="hljs-attribute">place_phone</span>": <span class="hljs-value"><span class="hljs-string">"09xx-xxxxxx"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="place-place-put" class="action put"><h4 class="action-heading"><div class="name">Update a Place</div><a href="#place-place-put" class="method put">PUT</a><code class="uri">/places/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/places/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="place-place-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Place</div><a href="#place-place-delete" class="method delete">DELETE</a><code class="uri">/places/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="count" class="resource-group"><h2 class="group-heading">Count <a href="#count" class="permalink">¶</a></h2><p>Represents Count Details</p>
<hr>
<p><strong>Count attributes:</strong></p>
<ul>
<li>
<p>count_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>lamp_id <code>(String(25))</code> : Require.</p>
</li>
<li>
<p>counts <code>(Number)</code> : Require.</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="count-count-collection" class="resource"><h3 class="resource-heading">Count Collection <a href="#count-count-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/counts?<span class="hljs-attribute">formatBy=</span><span class="hljs-literal">date</span>&<span class="hljs-attribute">lampHashID=</span><span class="hljs-literal">9b3814</span>&<span class="hljs-attribute">limit=</span><span class="hljs-literal">7</span>&<span class="hljs-attribute">lampID=</span><span class="hljs-literal">KG0915-01</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">200</span><span class="tab-button">200</span><span class="tab-button">200</span><span class="tab-button">200</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts will <span class="hljs-keyword">return</span>
[
{
<span class="hljs-string">"count_id"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"TEST01"</span>,
<span class="hljs-string">"counts"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"created_at"</span>: <span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>,
}, {
<span class="hljs-string">"count_id"</span>: <span class="hljs-number">2</span>,
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"TEST01"</span>,
<span class="hljs-string">"counts"</span>: <span class="hljs-number">2</span>,
<span class="hljs-string">"created_at"</span>: <span class="hljs-string">"2017-09-24T11:14:56.044Z"</span>,
}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts?lampID=TEST01 will <span class="hljs-keyword">return</span>
[
{
<span class="hljs-string">"count_id"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"TEST01"</span>,
<span class="hljs-string">"counts"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"created_at"</span>: <span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>,
}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts?lampHashID=<span class="hljs-number">9</span>b3814 will <span class="hljs-keyword">return</span>
[
{
<span class="hljs-string">"count_id"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"9b3814"</span>,
<span class="hljs-string">"counts"</span>: <span class="hljs-number">1</span>,
<span class="hljs-string">"created_at"</span>: <span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>,
}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts?formatBy=date will <span class="hljs-keyword">return</span>
{
<span class="hljs-string">"2017-10-05"</span>: {
<span class="hljs-string">"KG0915-02"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"KG0915-02"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
},
<span class="hljs-string">"KG0915-03"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"KG0915-03"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"95"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
}
},
<span class="hljs-string">"2017-10-06"</span>: {
<span class="hljs-string">"KG0915-02"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"KG0915-02"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"51"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-06"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
},
<span class="hljs-string">"KG0915-03"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"KG0915-03"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"92"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-06"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
}
}
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts?formatBy=date&lampHashID=<span class="hljs-number">9</span>b3814 will <span class="hljs-keyword">return</span>
{
<span class="hljs-string">"2017-10-05"</span>: {
<span class="hljs-string">"9b3814"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"9b3814"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
}
},
<span class="hljs-string">"2017-10-06"</span>: {
<span class="hljs-string">"9b3814"</span>: {
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"9b3814"</span>,
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"51"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-06"</span>,
<span class="hljs-string">"size"</span>: <span class="hljs-number">0</span>
}
}
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>use /counts?formatBy=hour&lampHashID=<span class="hljs-number">9</span>b3814 will <span class="hljs-keyword">return</span>
{
<span class="hljs-string">"2017-10-05"</span>: {
<span class="hljs-string">"8"</span>: {
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"hour"</span>: <span class="hljs-string">"8"</span>,
<span class="hljs-string">"lamp_id"</span>:<span class="hljs-string">"9b3814"</span>
},
<span class="hljs-string">"9"</span>: {
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"hour"</span>: <span class="hljs-string">"9"</span>,
<span class="hljs-string">"lamp_id"</span>:<span class="hljs-string">"9b3814"</span>
}
},
<span class="hljs-string">"2017-10-06"</span>: {
<span class="hljs-string">"1"</span>: {
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"hour"</span>: <span class="hljs-string">"8"</span>,
<span class="hljs-string">"lamp_id"</span>:<span class="hljs-string">"9b3814"</span>
},
<span class="hljs-string">"2"</span>: {
<span class="hljs-string">"sum"</span>: <span class="hljs-string">"30"</span>,
<span class="hljs-string">"date"</span>: <span class="hljs-string">"2017-10-05"</span>,
<span class="hljs-string">"hour"</span>: <span class="hljs-string">"9"</span>,
<span class="hljs-string">"lamp_id"</span>:<span class="hljs-string">"9b3814"</span>
}
}
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="count-count-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all counts</div><a href="#count-count-collection-get" class="method get">GET</a><code class="uri">/counts{?formatBy,lampHashID,limit,lampID}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>formatBy</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>date</span></span><p>use ‘?formatBy=date’ <= Return data Group By date & lamp_id</p>
</dd><dt>lampHashID</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>9b3814</span></span><p>use ‘?formatBy=hour&lampHashID=9b3814’ <= Return one lamp data Group By date & hour</p>
</dd><dt>limit</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>7</span></span><p>user ‘?limit=7’ <= return past 7 days data. e.g. today 10/8, reutrn data from 10/1 00:00</p>
</dd><dt>lampID</dt><dd><code>String</code> <span>(optional)</span> <span class="text-muted example"><strong>Example: </strong><span>KG0915-01</span></span><p>use ‘?formatBy=hour&lampID=KG0915-01’ <= Return one lamp data Group By date & hour</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/counts</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">counts</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/counts/3</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">count_id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">counts</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="count-count-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Count</div><a href="#count-count-collection-post" class="method post">POST</a><code class="uri">/counts</code></h4></div></div><hr class="split"><div class="middle"><div id="count-count" class="resource"><h3 class="resource-heading">Count <a href="#count-count" class="permalink">¶</a></h3><p>A single Count object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/counts/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">count_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">counts</span>": <span class="hljs-value"><span class="hljs-string">"1"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="count-count-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Count</div><a href="#count-count-get" class="method get">GET</a><code class="uri">/counts/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/counts/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="count-count-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Count</div><a href="#count-count-delete" class="method delete">DELETE</a><code class="uri">/counts/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="state" class="resource-group"><h2 class="group-heading">State <a href="#state" class="permalink">¶</a></h2><p>Represents State Details</p>
<hr>
<p><strong>State attributes:</strong></p>
<ul>
<li>
<p>state_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>lamp_id <code>(String(25))</code> : Require.</p>
</li>
<li>
<p>lamp_state <code>(Number)</code> : Require, 0~2.</p>
</li>
<li>
<p>lamp_check_date <code>(Date)</code> : optional.</p>
</li>
<li>
<p>lamp_check_person <code>(String(10))</code> : optional.</p>
</li>
<li>
<p>state_description <code>(TEXT)</code> : optional .</p>
</li>
<li>
<p>state_reason <code>TEXT)</code> : optional .</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
<li>
<p>updated_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="state-state-collection" class="resource"><h3 class="resource-heading">State Collection <a href="#state-state-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/states</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">state_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">lamp_check_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_check_person</span>": <span class="hljs-value"><span class="hljs-string">"張同學"</span></span>,
"<span class="hljs-attribute">state_description</span>": <span class="hljs-value"><span class="hljs-string">"無法傳送訊息"</span></span>,
"<span class="hljs-attribute">state_reason</span>": <span class="hljs-value"><span class="hljs-string">"推測是晶片故障"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>},
{
"<span class="hljs-attribute">state_id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST02"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.044Z"</span>
</span>}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="state-state-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all states</div><a href="#state-state-collection-get" class="method get">GET</a><code class="uri">/states</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/states</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/states/3</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">state_id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="state-state-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a State</div><a href="#state-state-collection-post" class="method post">POST</a><code class="uri">/states</code></h4></div></div><hr class="split"><div class="middle"><div id="state-state" class="resource"><h3 class="resource-heading">State <a href="#state-state" class="permalink">¶</a></h3><p>A single State object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/states/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">state_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">lamp_check_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-26"</span></span>,
"<span class="hljs-attribute">lamp_check_person</span>": <span class="hljs-value"><span class="hljs-string">"張同學"</span></span>,
"<span class="hljs-attribute">state_description</span>": <span class="hljs-value"><span class="hljs-string">"無法傳送訊息"</span></span>,
"<span class="hljs-attribute">state_reason</span>": <span class="hljs-value"><span class="hljs-string">"推測是晶片故障"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="state-state-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a State</div><a href="#state-state-get" class="method get">GET</a><code class="uri">/states/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/states/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">lamp_check_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-27"</span></span>,
"<span class="hljs-attribute">lamp_check_person</span>": <span class="hljs-value"><span class="hljs-string">"張同學"</span></span>,
"<span class="hljs-attribute">state_description</span>": <span class="hljs-value"><span class="hljs-string">"燈不會亮"</span></span>,
"<span class="hljs-attribute">state_reason</span>": <span class="hljs-value"><span class="hljs-string">"捕蚊燈故障，更換捕蚊燈"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">state_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">lamp_state</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">lamp_check_date</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-27"</span></span>,
"<span class="hljs-attribute">lamp_check_person</span>": <span class="hljs-value"><span class="hljs-string">"張同學"</span></span>,
"<span class="hljs-attribute">state_description</span>": <span class="hljs-value"><span class="hljs-string">"燈不會亮"</span></span>,
"<span class="hljs-attribute">state_reason</span>": <span class="hljs-value"><span class="hljs-string">"捕蚊燈故障，更換捕蚊燈"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="state-state-put" class="action put"><h4 class="action-heading"><div class="name">Update a State</div><a href="#state-state-put" class="method put">PUT</a><code class="uri">/states/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/states/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="state-state-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a State</div><a href="#state-state-delete" class="method delete">DELETE</a><code class="uri">/states/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="mcc" class="resource-group"><h2 class="group-heading">Mcc <a href="#mcc" class="permalink">¶</a></h2><p>Represents Mcc Details</p>
<hr>
<p><strong>Mcc attributes:</strong></p>
<ul>
<li>
<p>mcc_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>mcc_keys <code>([String(25)])</code> : Require.</p>
</li>
<li>
<p>mcc_points <code>([String(25)])</code> : Require.</p>
</li>
<li>
<p>mcc_center <code>(Double)</code> : Require.</p>
</li>
<li>
<p>rule_id <code>(Number)</code> : Require.</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="mcc-mcc-collection" class="resource"><h3 class="resource-heading">Mcc Collection <a href="#mcc-mcc-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/mcc</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">mcc_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">mcc_keys</span>": <span class="hljs-value">[
<span class="hljs-string">"TEST01"</span>,
<span class="hljs-string">"TEST02"</span>
]</span>,
"<span class="hljs-attribute">mcc_points</span>": <span class="hljs-value">[
<span class="hljs-string">"TEST01"</span>,
<span class="hljs-string">"TEST02"</span>
]</span>,
"<span class="hljs-attribute">mcc_center</span>": <span class="hljs-value">[
<span class="hljs-number">120.192393</span>,
<span class="hljs-number">22.9980096</span>
]</span>,
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span>
</span>}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="mcc-mcc-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all mcc</div><a href="#mcc-mcc-collection-get" class="method get">GET</a><code class="uri">/mcc</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/mcc</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">mcc_keys</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>]</span>,
"<span class="hljs-attribute">mcc_points</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>, <span class="hljs-string">"TEST03"</span>]</span>,
"<span class="hljs-attribute">mcc_center</span>": <span class="hljs-value">[<span class="hljs-number">120.192393</span>, <span class="hljs-number">22.9980096</span>]</span>,
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/mcc/2</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">mcc_id</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">mcc_keys</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>]</span>,
"<span class="hljs-attribute">mcc_points</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>, <span class="hljs-string">"TEST03"</span>]</span>,
"<span class="hljs-attribute">mcc_center</span>": <span class="hljs-value">[<span class="hljs-number">120.192393</span>, <span class="hljs-number">22.9980096</span>]</span>,
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.073Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="mcc-mcc-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Mcc</div><a href="#mcc-mcc-collection-post" class="method post">POST</a><code class="uri">/mcc</code></h4></div></div><hr class="split"><div class="middle"><div id="mcc-mcc" class="resource"><h3 class="resource-heading">Mcc <a href="#mcc-mcc" class="permalink">¶</a></h3><p>A single Mcc object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/mcc/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">mcc_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">mcc_keys</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>]</span>,
"<span class="hljs-attribute">mcc_points</span>": <span class="hljs-value">[<span class="hljs-string">"TEST01"</span>, <span class="hljs-string">"TEST02"</span>]</span>,
"<span class="hljs-attribute">mcc_center</span>": <span class="hljs-value">[<span class="hljs-number">120.192393</span>, <span class="hljs-number">22.9980096</span>]</span>,
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.035Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="mcc-mcc-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Mcc</div><a href="#mcc-mcc-get" class="method get">GET</a><code class="uri">/mcc/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/mcc/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="mcc-mcc-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Mcc</div><a href="#mcc-mcc-delete" class="method delete">DELETE</a><code class="uri">/mcc/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="rules" class="resource-group"><h2 class="group-heading">Rules <a href="#rules" class="permalink">¶</a></h2><p>Represents Rules Details</p>
<hr>
<p><strong>Rules attributes:</strong></p>
<ul>
<li>
<p>rule_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>timeline_upper_limit <code>(Number)</code> : Require.</p>
</li>
<li>
<p>distance_lower_limit <code>(Number)</code> : Require.</p>
</li>
<li>
<p>points_lower_limit <code>(Number)</code> : Require.</p>
</li>
<li>
<p>counts_lower_limit <code>(Number)</code> : Require.</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
<li>
<p>updated_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="rules-rules-collection" class="resource"><h3 class="resource-heading">Rules Collection <a href="#rules-rules-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/rules</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[
{
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">counts_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span>
</span>}
]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="rules-rules-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all rules</div><a href="#rules-rules-collection-get" class="method get">GET</a><code class="uri">/rules</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/rules</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">counts_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/rules/3</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">counts_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="rules-rules-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Rules</div><a href="#rules-rules-collection-post" class="method post">POST</a><code class="uri">/rules</code></h4></div></div><hr class="split"><div class="middle"><div id="rules-rules" class="resource"><h3 class="resource-heading">Rules <a href="#rules-rules" class="permalink">¶</a></h3><p>A single Rules object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/rules/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">5</span></span>,
"<span class="hljs-attribute">counts_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="rules-rules-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Rules</div><a href="#rules-rules-get" class="method get">GET</a><code class="uri">/rules/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/rules/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">10</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">rule_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">timeline_upper_limit</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">distance_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">500</span></span>,
"<span class="hljs-attribute">points_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">10</span></span>,
"<span class="hljs-attribute">counts_lower_limit</span>": <span class="hljs-value"><span class="hljs-number">20</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
"<span class="hljs-attribute">updated_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="rules-rules-put" class="action put"><h4 class="action-heading"><div class="name">Update a Rules</div><a href="#rules-rules-put" class="method put">PUT</a><code class="uri">/rules/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/rules/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="rules-rules-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Rules</div><a href="#rules-rules-delete" class="method delete">DELETE</a><code class="uri">/rules/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><section id="comments" class="resource-group"><h2 class="group-heading">Comments <a href="#comments" class="permalink">¶</a></h2><p>Represents Comments Details</p>
<hr>
<p><strong>Comments attributes:</strong></p>
<ul>
<li>
<p>comments_id <code>(Number)</code> : unique identifier.</p>
</li>
<li>
<p>lamp_id <code>(Number)</code> : Require.</p>
</li>
<li>
<p>comment_content <code>(Text)</code> : Require.</p>
</li>
<li>
<p>created_at <code>(Timestamps)</code> : – .</p>
</li>
</ul>
<hr>
</section></div><div class="middle"><div id="comments-comments-collection" class="resource"><h3 class="resource-heading">Comments Collection <a href="#comments-comments-collection" class="permalink">¶</a></h3></div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/comments</span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>[{
"<span class="hljs-attribute">comments_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">comment_content</span>": <span class="hljs-value"><span class="hljs-string">"我不會用"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
}]</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="comments-comments-collection-get" class="action get"><h4 class="action-heading"><div class="name">List all comments</div><a href="#comments-comments-collection-get" class="method get">GET</a><code class="uri">/comments</code></h4></div></div><hr class="split"><div class="right"><div class="definition"><span class="method post">POST</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/comments</span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>lamp_id should be <span class="hljs-number">6</span> characters lamp_hash_id
{
<span class="hljs-string">"lamp_id"</span>: <span class="hljs-string">"9b3814"</span>,
<span class="hljs-string">"comment_content"</span>: <span class="hljs-string">"我不會用"</span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">201</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span><br><span class="hljs-attribute">Location</span>: <span class="hljs-string">/comments/3</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">comments_id</span>": <span class="hljs-value"><span class="hljs-number">3</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">comment_content</span>": <span class="hljs-value"><span class="hljs-string">"我不會用"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="comments-comments-collection-post" class="action post"><h4 class="action-heading"><div class="name">Create a Comments</div><a href="#comments-comments-collection-post" class="method post">POST</a><code class="uri">/comments</code></h4></div></div><hr class="split"><div class="middle"><div id="comments-comments" class="resource"><h3 class="resource-heading">Comments <a href="#comments-comments" class="permalink">¶</a></h3><p>A single Comments object with all its details</p>
</div></div><div class="right"><div class="definition"><span class="method get">GET</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/comments/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span><span class="tab-button">404</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">comments_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">comment_content</span>": <span class="hljs-value"><span class="hljs-string">"我不會用"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">error</span>": <span class="hljs-value"><span class="hljs-string">"not found"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="comments-comments-get" class="action get"><h4 class="action-heading"><div class="name">Retrieve a Comments</div><a href="#comments-comments-get" class="method get">GET</a><code class="uri">/comments/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method put">PUT</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/comments/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="example-names"><span>Requests</span><span class="tab-button">example 1</span></div><div class="tab"><div><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">comment_content</span>": <span class="hljs-value"><span class="hljs-string">"我還是不會用"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">200</span></div><div class="tab"><div><div class="inner"><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">comments_id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">lamp_id</span>": <span class="hljs-value"><span class="hljs-string">"TEST01"</span></span>,
"<span class="hljs-attribute">comment_content</span>": <span class="hljs-value"><span class="hljs-string">"我還是不會用"</span></span>,
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"2017-09-24T11:14:56.066Z"</span></span>,
}</code></pre><div style="height: 1px;"></div></div></div></div></div></div></div></div><div class="middle"><div id="comments-comments-put" class="action put"><h4 class="action-heading"><div class="name">Update a Comments</div><a href="#comments-comments-put" class="method put">PUT</a><code class="uri">/comments/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="right"><div class="definition"><span class="method delete">DELETE</span> <span class="uri"><span class="hostname">https://mosquitokiller.csie.ncku.edu.tw/apis</span>/comments/<span class="hljs-attribute" title="id">1</span></span></div><div class="tabs"><div class="tabs"><div class="example-names"><span>Responses</span><span class="tab-button">204</span></div><div class="tab"><div><div class="inner"><div class="description text-muted">This response has no content.</div><div style="height: 1px;"></div></div></div></div></div></div></div><div class="middle"><div id="comments-comments-delete" class="action delete"><h4 class="action-heading"><div class="name">Delete a Comments</div><a href="#comments-comments-delete" class="method delete">DELETE</a><code class="uri">/comments/{id}</code></h4><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>Number</code> <span class="required">(required)</span> <span class="text-muted example"><strong>Example: </strong><span>1</span></span><p>Numeric <code>id</code> of the User to perform action with.</p>
</dd></dl></div></div></div><hr class="split"><div class="middle"><p style="text-align: center;" class="text-muted">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 01 Dec 2017</p></div></div></div></div><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';
/*
Determine if a string ends with another string.
*/
function endsWith(str, suffix) {
return str.indexOf(suffix, str.length - suffix.length) !== -1;
}
/*
Get a list of direct child elements by class name.
*/
function childrenByClass(element, name) {
var filtered = [];
for (var i = 0; i < element.children.length; i++) {
var child = element.children[i];
var classNames = child.className.split(' ');
if (classNames.indexOf(name) !== -1) {
filtered.push(child);
}
}
return filtered;
}
/*
Get an array [width, height] of the window.
*/
function getWindowDimensions() {
var w = window,
d = document,
e = d.documentElement,
g = d.body,
x = w.innerWidth || e.clientWidth || g.clientWidth,
y = w.innerHeight || e.clientHeight || g.clientHeight;
return [x, y];
}
/*
Collapse or show a request/response example.
*/
function toggleCollapseButton(event) {
var button = event.target.parentNode;
var content = button.parentNode.nextSibling;
var inner = content.children[0];
if (button.className.indexOf('collapse-button') === -1) {
// Clicked without hitting the right element?
return;
}
if (content.style.maxHeight && content.style.maxHeight !== '0px') {
// Currently showing, so let's hide it
button.className = 'collapse-button';
content.style.maxHeight = '0px';
} else {
// Currently hidden, so let's show it
button.className = 'collapse-button show';
content.style.maxHeight = inner.offsetHeight + 12 + 'px';
}
}
function toggleTabButton(event) {
var i, index;
var button = event.target;
// Get index of the current button.
var buttons = childrenByClass(button.parentNode, 'tab-button');
for (i = 0; i < buttons.length; i++) {
if (buttons[i] === button) {
index = i;
button.className = 'tab-button active';
} else {
buttons[i].className = 'tab-button';
}
}
// Hide other tabs and show this one.
var tabs = childrenByClass(button.parentNode.parentNode, 'tab');
for (i = 0; i < tabs.length; i++) {
if (i === index) {
tabs[i].style.display = 'block';
} else {
tabs[i].style.display = 'none';
}
}
}
/*
Collapse or show a navigation menu. It will not be hidden unless it
is currently selected or `force` has been passed.
*/
function toggleCollapseNav(event, force) {
var heading = event.target.parentNode;
var content = heading.nextSibling;
var inner = content.children[0];
if (heading.className.indexOf('heading') === -1) {
// Clicked without hitting the right element?
return;
}
if (content.style.maxHeight && content.style.maxHeight !== '0px') {
// Currently showing, so let's hide it, but only if this nav item
// is already selected. This prevents newly selected items from
// collapsing in an annoying fashion.
if (force || window.location.hash && endsWith(event.target.href, window.location.hash)) {
content.style.maxHeight = '0px';
}
} else {
// Currently hidden, so let's show it
content.style.maxHeight = inner.offsetHeight + 12 + 'px';
}
}
/*
Refresh the page after a live update from the server. This only
works in live preview mode (using the `--server` parameter).
*/
function refresh(body) {
document.querySelector('body').className = 'preload';
document.body.innerHTML = body;
// Re-initialize the page
init();
autoCollapse();
document.querySelector('body').className = '';
}
/*
Determine which navigation items should be auto-collapsed to show as many
as possible on the screen, based on the current window height. This also
collapses them.
*/
function autoCollapse() {
var windowHeight = getWindowDimensions()[1];
var itemsHeight = 64; /* Account for some padding */
var itemsArray = Array.prototype.slice.call(
document.querySelectorAll('nav .resource-group .heading'));
// Get the total height of the navigation items
itemsArray.forEach(function (item) {
itemsHeight += item.parentNode.offsetHeight;
});
// Should we auto-collapse any nav items? Try to find the smallest item
// that can be collapsed to show all items on the screen. If not possible,
// then collapse the largest item and do it again. First, sort the items
// by height from smallest to largest.
var sortedItems = itemsArray.sort(function (a, b) {
return a.parentNode.offsetHeight - b.parentNode.offsetHeight;
});
while (sortedItems.length && itemsHeight > windowHeight) {
for (var i = 0; i < sortedItems.length; i++) {
// Will collapsing this item help?
var itemHeight = sortedItems[i].nextSibling.offsetHeight;
if ((itemsHeight - itemHeight <= windowHeight) || i === sortedItems.length - 1) {
// It will, so let's collapse it, remove its content height from
// our total and then remove it from our list of candidates
// that can be collapsed.
itemsHeight -= itemHeight;
toggleCollapseNav({target: sortedItems[i].children[0]}, true);
sortedItems.splice(i, 1);
break;
}
}
}
}
/*
Initialize the interactive functionality of the page.
*/
function init() {
var i, j;
// Make collapse buttons clickable
var buttons = document.querySelectorAll('.collapse-button');
for (i = 0; i < buttons.length; i++) {
buttons[i].onclick = toggleCollapseButton;
// Show by default? Then toggle now.
if (buttons[i].className.indexOf('show') !== -1) {
toggleCollapseButton({target: buttons[i].children[0]});
}
}
var responseCodes = document.querySelectorAll('.example-names');
for (i = 0; i < responseCodes.length; i++) {
var tabButtons = childrenByClass(responseCodes[i], 'tab-button');
for (j = 0; j < tabButtons.length; j++) {
tabButtons[j].onclick = toggleTabButton;
// Show by default?
if (j === 0) {
toggleTabButton({target: tabButtons[j]});
}
}
}
// Make nav items clickable to collapse/expand their content.
var navItems = document.querySelectorAll('nav .resource-group .heading');
for (i = 0; i < navItems.length; i++) {
navItems[i].onclick = toggleCollapseNav;
// Show all by default
toggleCollapseNav({target: navItems[i].children[0]});
}
}
// Initial call to set up buttons
init();
window.onload = function () {
autoCollapse();
// Remove the `preload` class to enable animations
document.querySelector('body').className = '';
};
</script></body></html>