-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
4251 lines (4137 loc) · 340 KB
/
index.html
File metadata and controls
4251 lines (4137 loc) · 340 KB
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
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>Cubby External API</title>
<style media="screen">
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight .gh {
color: #999999;
}
.highlight .sr {
color: #f6aa11;
}
.highlight .go {
color: #888888;
}
.highlight .gp {
color: #555555;
}
.highlight .gs {
}
.highlight .gu {
color: #aaaaaa;
}
.highlight .nb {
color: #f6aa11;
}
.highlight .cm {
color: #75715e;
}
.highlight .cp {
color: #75715e;
}
.highlight .c1 {
color: #75715e;
}
.highlight .cs {
color: #75715e;
}
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
color: #75715e;
}
.highlight .err {
color: #960050;
}
.highlight .gr {
color: #960050;
}
.highlight .gt {
color: #960050;
}
.highlight .gd {
color: #49483e;
}
.highlight .gi {
color: #49483e;
}
.highlight .ge {
color: #49483e;
}
.highlight .kc {
color: #66d9ef;
}
.highlight .kd {
color: #66d9ef;
}
.highlight .kr {
color: #66d9ef;
}
.highlight .no {
color: #66d9ef;
}
.highlight .kt {
color: #66d9ef;
}
.highlight .mf {
color: #ae81ff;
}
.highlight .mh {
color: #ae81ff;
}
.highlight .il {
color: #ae81ff;
}
.highlight .mi {
color: #ae81ff;
}
.highlight .mo {
color: #ae81ff;
}
.highlight .m, .highlight .mb, .highlight .mx {
color: #ae81ff;
}
.highlight .sc {
color: #ae81ff;
}
.highlight .se {
color: #ae81ff;
}
.highlight .ss {
color: #ae81ff;
}
.highlight .sd {
color: #e6db74;
}
.highlight .s2 {
color: #e6db74;
}
.highlight .sb {
color: #e6db74;
}
.highlight .sh {
color: #e6db74;
}
.highlight .si {
color: #e6db74;
}
.highlight .sx {
color: #e6db74;
}
.highlight .s1 {
color: #e6db74;
}
.highlight .s, .highlight .sa, .highlight .dl {
color: #e6db74;
}
.highlight .na {
color: #a6e22e;
}
.highlight .nc {
color: #a6e22e;
}
.highlight .nd {
color: #a6e22e;
}
.highlight .ne {
color: #a6e22e;
}
.highlight .nf, .highlight .fm {
color: #a6e22e;
}
.highlight .vc {
color: #ffffff;
}
.highlight .nn {
color: #ffffff;
}
.highlight .ni {
color: #ffffff;
}
.highlight .bp {
color: #ffffff;
}
.highlight .vg {
color: #ffffff;
}
.highlight .vi {
color: #ffffff;
}
.highlight .nv, .highlight .vm {
color: #ffffff;
}
.highlight .w {
color: #ffffff;
}
.highlight {
color: #ffffff;
}
.highlight .n, .highlight .py, .highlight .nx {
color: #ffffff;
}
.highlight .nl {
color: #f92672;
}
.highlight .ow {
color: #f92672;
}
.highlight .nt {
color: #f92672;
}
.highlight .k, .highlight .kv {
color: #f92672;
}
.highlight .kn {
color: #f92672;
}
.highlight .kp {
color: #f92672;
}
.highlight .o {
color: #f92672;
}
</style>
<style media="print">
* {
-webkit-transition:none!important;
transition:none!important;
}
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight, .highlight .w {
color: #586e75;
}
.highlight .err {
color: #002b36;
background-color: #dc322f;
}
.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
color: #657b83;
}
.highlight .cp {
color: #b58900;
}
.highlight .nt {
color: #b58900;
}
.highlight .o, .highlight .ow {
color: #93a1a1;
}
.highlight .p, .highlight .pi {
color: #93a1a1;
}
.highlight .gi {
color: #859900;
}
.highlight .gd {
color: #dc322f;
}
.highlight .gh {
color: #268bd2;
background-color: #002b36;
font-weight: bold;
}
.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
color: #6c71c4;
}
.highlight .kc {
color: #cb4b16;
}
.highlight .kt {
color: #cb4b16;
}
.highlight .kd {
color: #cb4b16;
}
.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
color: #859900;
}
.highlight .sa {
color: #6c71c4;
}
.highlight .sr {
color: #2aa198;
}
.highlight .si {
color: #d33682;
}
.highlight .se {
color: #d33682;
}
.highlight .nn {
color: #b58900;
}
.highlight .nc {
color: #b58900;
}
.highlight .no {
color: #b58900;
}
.highlight .na {
color: #268bd2;
}
.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
color: #859900;
}
.highlight .ss {
color: #859900;
}
</style>
<link href="stylesheets/screen-9c19b03a.css" rel="stylesheet" media="screen" />
<link href="stylesheets/print-966d6edc.css" rel="stylesheet" media="print" />
<script src="javascripts/all-b12a2749.js"></script>
<script>
$(function() { setupCodeCopy(); });
</script>
</head>
<body class="index" data-languages="[]">
<a href="#" id="nav-button">
<span>
NAV
<img src="images/navbar.png" alt="" />
</span>
</a>
<div class="toc-wrapper">
<img src="images/logo-95c97c83.png" class="logo" alt="" />
<div class="search">
<input type="text" class="search" id="input-search" placeholder="Search">
</div>
<ul class="search-results"></ul>
<ul id="toc" class="toc-list-h1">
<li>
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
<ul class="toc-list-h2">
<li>
<a href="#ids" class="toc-h2 toc-link" data-title="IDs">IDs</a>
</li>
<li>
<a href="#money" class="toc-h2 toc-link" data-title="Money">Money</a>
</li>
<li>
<a href="#api-response-structure" class="toc-h2 toc-link" data-title="API Response Structure">API Response Structure</a>
</li>
<li>
<a href="#errors" class="toc-h2 toc-link" data-title="Errors">Errors</a>
</li>
<li>
<a href="#expansions" class="toc-h2 toc-link" data-title="Expansions">Expansions</a>
</li>
</ul>
</li>
<li>
<a href="#operator-api" class="toc-h1 toc-link" data-title="Operator API">Operator API</a>
<ul class="toc-list-h2">
<li>
<a href="#authentication" class="toc-h2 toc-link" data-title="Authentication">Authentication</a>
</li>
<li>
<a href="#access-to-pii" class="toc-h2 toc-link" data-title="Access to PII">Access to PII</a>
</li>
<li>
<a href="#access-codes-search" class="toc-h2 toc-link" data-title="Access Codes Search">Access Codes Search</a>
</li>
<li>
<a href="#check-access-code" class="toc-h2 toc-link" data-title="Check Access Code">Check Access Code</a>
</li>
<li>
<a href="#lock-register" class="toc-h2 toc-link" data-title="Lock Register">Lock Register</a>
</li>
<li>
<a href="#lock-search" class="toc-h2 toc-link" data-title="Lock Search">Lock Search</a>
</li>
<li>
<a href="#lock-disable" class="toc-h2 toc-link" data-title="Lock Disable">Lock Disable</a>
</li>
<li>
<a href="#lock-attach" class="toc-h2 toc-link" data-title="Lock Attach">Lock Attach</a>
</li>
<li>
<a href="#lock-return" class="toc-h2 toc-link" data-title="Lock Return">Lock Return</a>
</li>
<li>
<a href="#lock-transfer" class="toc-h2 toc-link" data-title="Lock Transfer">Lock Transfer</a>
</li>
<li>
<a href="#organizations-search" class="toc-h2 toc-link" data-title="Organizations Search">Organizations Search</a>
</li>
<li>
<a href="#managers-search" class="toc-h2 toc-link" data-title="Managers Search">Managers Search</a>
</li>
<li>
<a href="#facilities-search" class="toc-h2 toc-link" data-title="Facilities Search">Facilities Search</a>
</li>
<li>
<a href="#units-search" class="toc-h2 toc-link" data-title="Units Search">Units Search</a>
</li>
<li>
<a href="#unit-set-rentability" class="toc-h2 toc-link" data-title="Unit Set Rentability">Unit Set Rentability</a>
</li>
<li>
<a href="#pricing-group-search" class="toc-h2 toc-link" data-title="Pricing Group Search">Pricing Group Search</a>
</li>
<li>
<a href="#customers-search" class="toc-h2 toc-link" data-title="Customers Search">Customers Search</a>
</li>
<li>
<a href="#customer-update" class="toc-h2 toc-link" data-title="Customer Update">Customer Update</a>
</li>
<li>
<a href="#leads-search" class="toc-h2 toc-link" data-title="Leads Search">Leads Search</a>
</li>
<li>
<a href="#leads-create" class="toc-h2 toc-link" data-title="Leads Create">Leads Create</a>
</li>
<li>
<a href="#leases-search" class="toc-h2 toc-link" data-title="Leases Search">Leases Search</a>
</li>
<li>
<a href="#leases-get-compliances" class="toc-h2 toc-link" data-title="Leases Get Compliances">Leases Get Compliances</a>
</li>
<li>
<a href="#leases-get-rent-change-schedules" class="toc-h2 toc-link" data-title="Leases Get Rent Change Schedules">Leases Get Rent Change Schedules</a>
</li>
<li>
<a href="#leases-change-rents" class="toc-h2 toc-link" data-title="Leases Change Rents">Leases Change Rents</a>
</li>
<li>
<a href="#leases-cancel-rent-changes" class="toc-h2 toc-link" data-title="Leases Cancel Rent Changes">Leases Cancel Rent Changes</a>
</li>
<li>
<a href="#lease-update-alternative-contacts" class="toc-h2 toc-link" data-title="Lease Update Alternative Contacts">Lease Update Alternative Contacts</a>
</li>
<li>
<a href="#get-move-in-charges" class="toc-h2 toc-link" data-title="Get Move-In Charges">Get Move-In Charges</a>
</li>
<li>
<a href="#create-lease" class="toc-h2 toc-link" data-title="Create Lease">Create Lease</a>
</li>
<li>
<a href="#cancel-lease" class="toc-h2 toc-link" data-title="Cancel Lease">Cancel Lease</a>
</li>
<li>
<a href="#schedule-move-out" class="toc-h2 toc-link" data-title="Schedule Move Out">Schedule Move Out</a>
</li>
<li>
<a href="#payment-methods-search" class="toc-h2 toc-link" data-title="Payment Methods Search">Payment Methods Search</a>
</li>
<li>
<a href="#generating-a-payment-token" class="toc-h2 toc-link" data-title="Generating a Payment Token">Generating a Payment Token</a>
</li>
<li>
<a href="#create-payment-method" class="toc-h2 toc-link" data-title="Create Payment Method">Create Payment Method</a>
</li>
<li>
<a href="#get-payment-link" class="toc-h2 toc-link" data-title="Get Payment Link">Get Payment Link</a>
</li>
<li>
<a href="#make-payment" class="toc-h2 toc-link" data-title="Make Payment">Make Payment</a>
</li>
<li>
<a href="#enable-autopay" class="toc-h2 toc-link" data-title="Enable AutoPay">Enable AutoPay</a>
</li>
<li>
<a href="#disable-autopay" class="toc-h2 toc-link" data-title="Disable AutoPay">Disable AutoPay</a>
</li>
<li>
<a href="#ledger-search" class="toc-h2 toc-link" data-title="Ledger Search">Ledger Search</a>
</li>
<li>
<a href="#add-private-policy-info" class="toc-h2 toc-link" data-title="Add private policy info">Add private policy info</a>
</li>
<li>
<a href="#remove-private-policy-info" class="toc-h2 toc-link" data-title="Remove private policy info">Remove private policy info</a>
</li>
<li>
<a href="#download-private-policy" class="toc-h2 toc-link" data-title="Download Private Policy">Download Private Policy</a>
</li>
<li>
<a href="#coverage-plans" class="toc-h2 toc-link" data-title="Coverage plans">Coverage plans</a>
</li>
<li>
<a href="#coverage-policies-search" class="toc-h2 toc-link" data-title="Coverage Policies Search">Coverage Policies Search</a>
</li>
<li>
<a href="#coverage-enroll" class="toc-h2 toc-link" data-title="Coverage Enroll">Coverage Enroll</a>
</li>
<li>
<a href="#coverage-policy-unenroll" class="toc-h2 toc-link" data-title="Coverage Policy Unenroll">Coverage Policy Unenroll</a>
</li>
<li>
<a href="#payments-search" class="toc-h2 toc-link" data-title="Payments Search">Payments Search</a>
</li>
<li>
<a href="#auctions-search" class="toc-h2 toc-link" data-title="Auctions Search">Auctions Search</a>
</li>
<li>
<a href="#auction-create" class="toc-h2 toc-link" data-title="Auction Create">Auction Create</a>
</li>
<li>
<a href="#start-lien-process" class="toc-h2 toc-link" data-title="Start lien process">Start lien process</a>
</li>
<li>
<a href="#cancel-lien-process" class="toc-h2 toc-link" data-title="Cancel lien process">Cancel lien process</a>
</li>
<li>
<a href="#notes-search" class="toc-h2 toc-link" data-title="Notes Search">Notes Search</a>
</li>
<li>
<a href="#notes-create" class="toc-h2 toc-link" data-title="Notes Create">Notes Create</a>
</li>
<li>
<a href="#tasks-search" class="toc-h2 toc-link" data-title="Tasks Search">Tasks Search</a>
</li>
<li>
<a href="#tasks-create" class="toc-h2 toc-link" data-title="Tasks Create">Tasks Create</a>
</li>
<li>
<a href="#general-ledger-cash-based-report" class="toc-h2 toc-link" data-title="General Ledger Cash Based Report">General Ledger Cash Based Report</a>
</li>
<li>
<a href="#general-ledger-accrual-based-report" class="toc-h2 toc-link" data-title="General Ledger Accrual Based Report">General Ledger Accrual Based Report</a>
</li>
<li>
<a href="#aged-receivables-report" class="toc-h2 toc-link" data-title="Aged Receivables Report">Aged Receivables Report</a>
</li>
<li>
<a href="#rent-roll-report" class="toc-h2 toc-link" data-title="Rent Roll Report">Rent Roll Report</a>
</li>
<li>
<a href="#storefront-facilities-search" class="toc-h2 toc-link" data-title="Storefront Facilities Search">Storefront Facilities Search</a>
</li>
<li>
<a href="#storefront-pricing-groups-search" class="toc-h2 toc-link" data-title="Storefront Pricing Groups Search">Storefront Pricing Groups Search</a>
</li>
<li>
<a href="#send-sms" class="toc-h2 toc-link" data-title="Send SMS">Send SMS</a>
</li>
<li>
<a href="#send-email" class="toc-h2 toc-link" data-title="Send Email">Send Email</a>
</li>
<li>
<a href="#checkout-component" class="toc-h2 toc-link" data-title="Checkout Component">Checkout Component</a>
</li>
</ul>
</li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id='introduction'>Introduction</h1>
<p>This is a JSON HTTP API. It is not a RESTful API.</p>
<p>In contrast to REST, which is focused on the <em>transfer of state</em> between server and client,
this API is oriented around <em>actions</em> that can be performed on system entities, and
offers consistent <em>in-band</em> error reporting (so, generally HTTP response codes
do not need to be inspected; only the bodies of server responses).</p>
<h3 id='ids'>IDs</h3>
<blockquote>
<p>Example Entity IDs</p>
</blockquote>
<div class="highlight"><pre class="highlight plaintext"><code>cust_FiUtBj8JkF
lease_jOi8joH3Hu
org_Ji9JKfKkhuR
quote_IJf03jNjKuf
</code></pre></div>
<p>Entity IDs in Cubby are generally in the form of <code><prefix>_<alpha></code> where the
type of the object referred to is defined by the prefix.</p>
<h3 id='money'>Money</h3>
<p>We represent money as an integer, representing the number of cents. There are problems both in the use of integers and in the use of floats to represent money. We believe use of integers results in more predictable and obvious behavior for users of our API, and forces anyone that sends us money to confront a possible loss of precision before sending us numbers.</p>
<h3 id='api-response-structure'>API Response Structure</h3><div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"success"</span><span class="p">,</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="c">/* Data content entirely specific to the endpoint */</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="nl">"errorCode"</span><span class="p">:</span><span class="w"> </span><span class="mi">1008</span><span class="p">,</span><span class="w"> </span><span class="c">/* See error codes doc */</span><span class="w">
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="c">/* In the case of errors, at least one string will be present here */</span><span class="w">
</span><span class="s2">"Plain english explanation regarding part of request"</span><span class="p">,</span><span class="w">
</span><span class="s2">"Plain english explanation regarding yet another part"</span><span class="p">,</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>All valid HTTP Responses to the API will result in an HTTP
response with an HTTP/200 status. This is true regardless
of whether the HTTP request was successful.</p>
<p>All errors are reported "in-band" with appropriate codes and
messages set within the JSON body.</p>
<h3 id='errors'>Errors</h3>
<blockquote>
<p>Error Response Example</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"error"</span><span class="p">,</span><span class="w">
</span><span class="nl">"errorCode"</span><span class="p">:</span><span class="w"> </span><span class="mi">1008</span><span class="p">,</span><span class="w">
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="s2">"Facility not found"</span><span class="p">,</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>When a request fails, the response <code>status</code> will be <code>"error"</code>. The <code>errors</code> array will contain
one or more plain-english strings describing what went wrong. An <code>errorCode</code> may also be present
to allow programmatic handling of specific error conditions.</p>
<p>Common reasons for errors include:</p>
<ul>
<li>Missing or invalid required properties</li>
<li>Referencing entities that do not exist or are not accessible</li>
<li>Attempting an action that violates business rules (e.g. attaching a lock to a unit that already has one)</li>
<li>Authentication failures (invalid or missing API key)</li>
</ul>
<p>The <code>data</code> field will be absent or <code>null</code> when the response is an error.</p>
<h3 id='expansions'>Expansions</h3>
<p>APIs strive to return comprehensive information in the target entity. Entities in the Cubby system tend to be connected
to other entities (for example a <code>lease</code> and a <code>customer</code>), and it may be desirable to retrieve both a subject entity as
well as related entities in a single HTTP request.</p>
<p>To accommodate this, some endpoints offer <code>expansions</code>, which are effectively instruction on which related entities should
be retrieved <em>in addition to</em> the base entity returned by the endpoint.</p>
<p>Expansions are not expanded in-line, but are provided as auxiliary arrays which can easily be combined by using the
embedded entity IDs.</p>
<h1 id='operator-api'>Operator API</h1>
<p>API credentials conceptually attach to the <em>Organization</em> concept, and
has access to all resources (managers, facilities, customers, leases) visible
to the Organization.</p>
<h3 id='authentication'>Authentication</h3>
<p>Authentication is done via an API key, which is passed in the <code>Authorization</code> header.
Example via curl:</p>
<div class="highlight"><pre class="highlight plaintext"><code>curl -X 'POST' https://api.cubbystorage.com/v1/organizations/search -H 'accept: */*' -H 'Authorization: Bearer b73c7e4d-81f2-49e3-bbca-9a6fbd321d56' -H "Content-Type: application/json" -d '{"where": {}}'
</code></pre></div>
<p>In order to obtain an API key, please contact support@cubbystorage.com.</p>
<p>Treat your API key like a password - because that’s what it is!</p>
<h2 id='access-to-pii'>Access to PII</h2>
<p>Access to Personally Identifiable Information (PII) is restricted to authorized users only. If your API key does not have access to PII, all PII fields will be skipped in API responses. PII fields include:</p>
<ul>
<li>Customer names</li>
<li>Customer addresses</li>
<li>Customer phone numbers</li>
<li>Customer email addresses</li>
<li>Customer date of birth</li>
<li>Customer ID numbers</li>
<li>Alternative contact names</li>
<li>Alternative contact phone numbers</li>
<li>Alternative contact email addresses</li>
<li>Vehicle license numbers</li>
<li>Vehicle states</li>
</ul>
<h2 id='access-codes-search'>Access Codes Search</h2>
<p><code>POST /v1/access-codes/search</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"where"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"customerId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cust_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"accessCodes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1575"</span><span class="p">,</span><span class="w">
</span><span class="nl">"enabled"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"customerId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cust_K2kybwxRz9L"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="c">/* ... */</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Search for access codes by facility or customer</p>
<h3 id='required-properties'>Required Properties</h3>
<ul>
<li><code>facilityId</code> - the ID of the facility to search for access codes</li>
</ul>
<h2 id='check-access-code'>Check Access Code</h2>
<p><code>POST /v1/access-codes/check</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"code"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1575"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"accessAllowed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
</span><span class="nl">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Access allowed"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Check if an access code is valid for a facility</p>
<h3 id='required-properties-2'>Required Properties</h3>
<ul>
<li><code>facilityId</code> - the ID of the facility to check the access code against</li>
<li><code>code</code> - the access code to check</li>
</ul>
<h3 id='response-parameters'>Response Parameters</h3>
<ul>
<li><code>accessAllowed</code> - a boolean indicating if the access code is valid</li>
<li><code>message</code> - a message indicating the result of the check; examples include <code>"Access allowed"</code>, <code>"Code not found"</code>, and
<code>"Code disabled"</code></li>
</ul>
<h2 id='lock-register'>Lock Register</h2>
<p><code>POST /v1/locks/register</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"serial"</span><span class="p">:</span><span class="w"> </span><span class="s2">"M9U2FK"</span><span class="p">,</span><span class="w">
</span><span class="nl">"combo"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2934"</span><span class="p">,</span><span class="w">
</span><span class="nl">"location"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac|org_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"actor"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Adds a new lock to the system. The lock is initially in an "available" state.
Available locks can be associated with a location until they are attached to a unit.</p>
<h3 id='required-properties-3'>Required Properties</h3>
<ul>
<li><code>serial</code> - the serial number of the lock</li>
<li><code>combo</code> - the current combination for unlocking the lock</li>
<li><code>location</code> - the <code>facility</code> or <code>organization</code> where the lock is physically present</li>
</ul>
<h3 id='error-conditions'>Error Conditions</h3>
<ul>
<li>It is an error to add a lock whose serial already exists in the system</li>
</ul>
<h3 id='response-parameters-2'>Response Parameters</h3>
<table><thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr>
<td>id</td>
<td>The ID of the newly registered lock</td>
</tr>
</tbody></table>
<h2 id='lock-search'>Lock Search</h2>
<p><code>POST /v1/locks/search</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"where"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"locks"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac_C7bSZyPT6fp"</span><span class="p">,</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"serial"</span><span class="p">:</span><span class="w"> </span><span class="s2">"M9U2FK"</span><span class="p">,</span><span class="w">
</span><span class="nl">"combo"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2934"</span><span class="p">,</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AVAILABLE | OPERATOR_USE | TENANT_USE | DISABLED"</span><span class="p">,</span><span class="w">
</span><span class="nl">"attachedTo"</span><span class="p">:</span><span class="w"> </span><span class="s2">"unit_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"disabledReason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DAMAGED | MISSING"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="c">/* ... */</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Search for locks by organization</p>
<h3 id='required-properties-4'>Required Properties</h3>
<ul>
<li><code>organizationId</code> - the ID of the organization to search for locks</li>
</ul>
<h3 id='response-parameters-3'>Response Parameters</h3>
<table><thead>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
</thead><tbody>
<tr>
<td>id</td>
<td>The ID of the lock</td>
</tr>
<tr>
<td>facilityId</td>
<td>The facility where the lock is physically present</td>
</tr>
<tr>
<td>organizationId</td>
<td>The organization where the lock is physically present</td>
</tr>
<tr>
<td>serial</td>
<td>The serial number of the lock</td>
</tr>
<tr>
<td>combo</td>
<td>The current combination for unlocking the lock</td>
</tr>
<tr>
<td>status</td>
<td>The current status of the lock.</td>
</tr>
<tr>
<td>attachedTo</td>
<td>The unit to which the lock is attached (only when status is either <code>OPERATOR_USE</code> or <code>TENANT_USE</code>)</td>
</tr>
<tr>
<td>disabledReason</td>
<td>The reason the lock is disabled (only when status is <code>DISABLED</code>)</td>
</tr>
</tbody></table>
<h2 id='lock-disable'>Lock Disable</h2>
<p><code>POST /v1/locks/disable</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"lockId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DAMAGED | MISSING"</span><span class="p">,</span><span class="w">
</span><span class="nl">"actor"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Marks the lock as disabled, detaching it from any units it may be attached to.</p>
<h3 id='required-properties-5'>Required Properties</h3>
<ul>
<li><code>lockId</code> - the ID of the lock which will be disabled</li>
<li><code>reason</code> - the reason for disabling the lock, which can be <code>DAMAGED</code> or <code>MISSING</code></li>
</ul>
<h3 id='optional-properties'>Optional Properties</h3>
<ul>
<li><code>actor</code> - the user who performed this action</li>
</ul>
<h2 id='lock-attach'>Lock Attach</h2>
<p><code>POST /v1/locks/attach</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"lockId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"attachTo"</span><span class="p">:</span><span class="w"> </span><span class="s2">"space_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"lockUse"</span><span class="p">:</span><span class="w"> </span><span class="s2">"TENANT_USE | OPERATOR_USE"</span><span class="p">,</span><span class="w">
</span><span class="nl">"actor"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Attaches a lock to a unit either by renting it to a tenant or by restricting access to the unit.</p>
<h3 id='required-properties-6'>Required Properties</h3>
<ul>
<li><code>lockId</code> - the ID of the lock</li>
<li><code>attachTo</code> - the ID of the space the lock will be attached to</li>
<li><code>lockUse</code> - <code>TENANT_USE</code> lock use means that the lock has been rented-to or loaned-to a tenant; the code will be
immediately accessible to the tenant, and it is even possible that the tenant will change the code. <code>OPERATOR_USE</code> means
the purpose of the lock is to restrict access to the unit</li>
</ul>
<h3 id='optional-properties-2'>Optional Properties</h3>
<ul>
<li><code>actor</code> - the user who performed this action</li>
</ul>
<h3 id='error-conditions-2'>Error Conditions</h3>
<ul>
<li>Cannot attach a lock to a space which already has a different lock attached to it</li>
</ul>
<h2 id='lock-return'>Lock Return</h2>
<p><code>POST /v1/locks/return</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"lockId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"actor"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Puts the lock back into inventory, detaching it from any unit it may be currently attached to and
marking it available for re-use.</p>
<h3 id='required-properties-7'>Required Properties</h3>
<ul>
<li><code>lockId</code> - the ID of the lock</li>
</ul>
<h3 id='optional-properties-3'>Optional Properties</h3>
<ul>
<li><code>actor</code> - the user who performed this action</li>
</ul>
<h2 id='lock-transfer'>Lock Transfer</h2>
<p><code>POST /v1/locks/transfer</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"lockId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"lock_<ID>"</span><span class="p">,</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"facility_<ID>"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Transfers the lock to a different facility, which must belong to the same organization as the lock's current facility.
The lock must not be attached to a unit.</p>
<h3 id='required-properties-8'>Required Properties</h3>
<ul>
<li><code>lockId</code> - the ID of the lock</li>
<li><code>facilityId</code> - the ID of the facility to which the lock will be transferred</li>
</ul>
<h2 id='organizations-search'>Organizations Search</h2>
<p><code>POST /v1/organizations/search</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"where"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"organizations"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Anisha Estates"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="c">/* ... */</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
</span><span class="nl">"errors"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<p>Returns metadata for co-managed organization(s)</p>
<h3 id='optional-properties-4'>Optional Properties</h3>
<ul>
<li><code>organizationId</code> - limits results to organizations with a specific ID, otherwise all co-managed organizations are
returned</li>
</ul>
<h2 id='managers-search'>Managers Search</h2>
<p><code>POST /v1/managers/search</code></p>
<blockquote>
<p>Request Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"where"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac_C7bSZyPT6fp"</span><span class="p">,</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"555-555-5555"</span><span class="p">,</span><span class="w">
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"manager@example.com"</span><span class="p">,</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jane"</span><span class="p">,</span><span class="w">
</span><span class="nl">"includePermissions"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>Response Body</p>
</blockquote>
<div class="highlight"><pre class="highlight json-doc tab-json-doc"><code><span class="p">{</span><span class="w">
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"managers"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nl">"managerId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"user_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Jane Smith"</span><span class="p">,</span><span class="w">
</span><span class="nl">"email"</span><span class="p">:</span><span class="w"> </span><span class="s2">"manager@example.com"</span><span class="p">,</span><span class="w">
</span><span class="nl">"phone"</span><span class="p">:</span><span class="w"> </span><span class="s2">"555-555-5555"</span><span class="p">,</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"organizationPermissions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"organizationId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"org_4a2da7d271a"</span><span class="p">,</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Anisha Estates"</span><span class="p">,</span><span class="w">
</span><span class="nl">"permissions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"read"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"Task"</span><span class="p">],</span><span class="w">
</span><span class="nl">"manage"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"Task"</span><span class="p">,</span><span class="w"> </span><span class="s2">"Note"</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"facilitiesPermissions"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
</span><span class="p">{</span><span class="w">
</span><span class="nl">"facilityId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fac_C7bSZyPT6fp"</span><span class="p">,</span><span class="w">
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"315 Anisha Estates"</span><span class="p">,</span><span class="w">
</span><span class="nl">"permissions"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"read"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"Task"</span><span class="p">],</span><span class="w">
</span><span class="nl">"manage"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"Task"</span><span class="p">,</span><span class="w"> </span><span class="s2">"Note"</span><span class="p">]</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="p">{</span><span class="c">/* ... */</span><span class="p">}</span><span class="w">
</span><span class="p">]</span><span class="w">