@groton/veracross-api 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/package.json +3 -2
  3. package/spec/Authorization-API.yaml +0 -732
  4. package/spec/Data-API.yaml +0 -73643
  5. package/spec/Files-API.yaml +0 -1041
  6. package/templates/client.handlebars +0 -25
  7. package/templates/create.handlebars +0 -23
  8. package/templates/delete.handlebars +0 -20
  9. package/templates/get.handlebars +0 -24
  10. package/templates/index.handlebars +0 -2
  11. package/templates/list.handlebars +0 -50
  12. package/templates/post.handlebars +0 -31
  13. package/templates/read.handlebars +0 -24
  14. package/templates/update.handlebars +0 -22
package/spec/Files-API.yaml DELETED
@@ -1,1041 +0,0 @@
1
- openapi: 3.0.3
2
- info:
3
- title: Files API
4
- description: 'Please visit [Using the Files API](../docs/guides/making-a-files-api-request.md) to get started'
5
- contact:
6
- name: Veracross
7
- url: 'https://www.veracross.com/api'
8
- version: 3.0.0
9
- servers:
10
- - url: 'https://api.veracross.com/{school_route}/v3/files'
11
- description: Base URL
12
- paths:
13
- /applicant_file:
14
- post:
15
- tags:
16
- - 'Admissions: Applicant Files'
17
- summary: 'Create Admissions: Applicant Files'
18
- operationId: create_admissions_applicant_files
19
- requestBody:
20
- content:
21
- application/json:
22
- schema:
23
- type: object
24
- properties:
25
- data:
26
- type: object
27
- properties:
28
- id:
29
- type: integer
30
- description: File ID
31
- readOnly: true
32
- person_id:
33
- type: integer
34
- description: Person ID
35
- description:
36
- type: string
37
- description: Description (Text)
38
- maxLength: 1000
39
- classification:
40
- type: string
41
- description: Classification
42
- year_applying_for:
43
- type: integer
44
- description: |-
45
- Year Applying For
46
-
47
- Person Year Applying For
48
- school_year:
49
- type: integer
50
- description: School Year
51
- notes:
52
- type: string
53
- description: Notes
54
- required:
55
- - data
56
- responses:
57
- '201':
58
- description: Created
59
- content:
60
- application/json:
61
- schema:
62
- type: object
63
- properties:
64
- data:
65
- type: object
66
- properties:
67
- id:
68
- type: integer
69
- description: File ID
70
- required:
71
- - id
72
- upload_url:
73
- type: string
74
- description: |
75
- - Make request using PUT method
76
- - Provide raw file in request body (not multipart/form-data)
77
- - URL accepts one upload only; reusing it is rejected
78
- - Expires after 5 minutes
79
- - Allowed file types: `text/csv`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `image/gif`, `image/jpeg`, `application/pdf`, `image/png`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`, `text/plain`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/zip`
80
- - Max file size: 10 MB
81
- required:
82
- - data
83
- - upload_url
84
- headers:
85
- X-API-Revision:
86
- required: true
87
- description: API Revision
88
- schema:
89
- type: string
90
- 4XX:
91
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
92
- content:
93
- application/json:
94
- schema:
95
- $ref: '#/components/schemas/error'
96
- 5XX:
97
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
98
- content:
99
- application/json:
100
- schema:
101
- $ref: '#/components/schemas/error'
102
- security:
103
- - access_token:
104
- - 'files:applicant_file:create'
105
- parameters:
106
- - $ref: '#/components/parameters/api_revision'
107
- get:
108
- tags:
109
- - 'Admissions: Applicant Files'
110
- summary: 'List Admissions: Applicant Files'
111
- operationId: list_admissions_applicant_files
112
- parameters:
113
- - name: person_id
114
- in: query
115
- description: Person ID
116
- required: false
117
- schema:
118
- type: integer
119
- - name: year_applying_for
120
- in: query
121
- description: |-
122
- Year Applying For
123
-
124
- Person Year Applying For
125
- required: false
126
- schema:
127
- type: integer
128
- - name: school_year
129
- in: query
130
- description: School Year
131
- required: false
132
- schema:
133
- type: integer
134
- - $ref: '#/components/parameters/page_number'
135
- - $ref: '#/components/parameters/page_size'
136
- - $ref: '#/components/parameters/value_lists'
137
- responses:
138
- '200':
139
- description: OK
140
- content:
141
- application/json:
142
- schema:
143
- type: object
144
- properties:
145
- data:
146
- type: array
147
- items:
148
- type: object
149
- properties:
150
- id:
151
- type: integer
152
- description: File ID
153
- readOnly: true
154
- person_id:
155
- type: integer
156
- description: Person ID
157
- status:
158
- type: integer
159
- description: API Upload Status
160
- error:
161
- type: string
162
- description: API Upload Error
163
- description:
164
- type: string
165
- description: Description (Text)
166
- maxLength: 1000
167
- classification:
168
- type: string
169
- description: Classification
170
- year_applying_for:
171
- type: integer
172
- description: |-
173
- Year Applying For
174
-
175
- Person Year Applying For
176
- school_year:
177
- type: integer
178
- description: School Year
179
- notes:
180
- type: string
181
- description: Notes
182
- download_url:
183
- type: string
184
- description: Applicant File Download
185
- readOnly: true
186
- required:
187
- - id
188
- - person_id
189
- - status
190
- - error
191
- - description
192
- - classification
193
- - year_applying_for
194
- - school_year
195
- - notes
196
- - download_url
197
- value_lists:
198
- type: array
199
- description: Present only with header `X-API-Value-Lists = include`
200
- readOnly: true
201
- items:
202
- type: object
203
- properties:
204
- fields:
205
- type: array
206
- description: An array of field names from `data` that this value list goes with
207
- items:
208
- type: string
209
- enum:
210
- - status
211
- - year_applying_for
212
- - school_year
213
- items:
214
- type: array
215
- description: An array of value list items whose `id` field matches the value in the response data
216
- items:
217
- type: object
218
- properties:
219
- id:
220
- type: string
221
- description:
222
- type: string
223
- category:
224
- type: integer
225
- sort_key:
226
- type: integer
227
- obsolete:
228
- type: boolean
229
- required:
230
- - id
231
- - description
232
- - sort_key
233
- categories:
234
- type: array
235
- description: 'An array of "category" objects, which allow you to partition the value list items according to their category field'
236
- items:
237
- type: object
238
- properties:
239
- id:
240
- type: integer
241
- description:
242
- type: string
243
- sort_key:
244
- type: integer
245
- required:
246
- - id
247
- - description
248
- - sort_key
249
- required:
250
- - fields
251
- - items
252
- - categories
253
- required:
254
- - data
255
- headers:
256
- X-API-Revision:
257
- required: true
258
- description: API Revision
259
- schema:
260
- type: string
261
- 4XX:
262
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
263
- content:
264
- application/json:
265
- schema:
266
- $ref: '#/components/schemas/error'
267
- 5XX:
268
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
269
- content:
270
- application/json:
271
- schema:
272
- $ref: '#/components/schemas/error'
273
- security:
274
- - access_token:
275
- - 'files:applicant_file:list'
276
- '/applicant_file/{id}':
277
- get:
278
- tags:
279
- - 'Admissions: Applicant Files'
280
- summary: 'Read Admissions: Applicant Files'
281
- operationId: read_admissions_applicant_files
282
- parameters:
283
- - $ref: '#/components/parameters/value_lists'
284
- responses:
285
- '200':
286
- description: OK
287
- content:
288
- application/json:
289
- schema:
290
- type: object
291
- properties:
292
- data:
293
- type: object
294
- properties:
295
- id:
296
- type: integer
297
- description: File ID
298
- readOnly: true
299
- person_id:
300
- type: integer
301
- description: Person ID
302
- status:
303
- type: integer
304
- description: API Upload Status
305
- error:
306
- type: string
307
- description: API Upload Error
308
- description:
309
- type: string
310
- description: Description (Text)
311
- maxLength: 1000
312
- classification:
313
- type: string
314
- description: Classification
315
- year_applying_for:
316
- type: integer
317
- description: |-
318
- Year Applying For
319
-
320
- Person Year Applying For
321
- school_year:
322
- type: integer
323
- description: School Year
324
- notes:
325
- type: string
326
- description: Notes
327
- download_url:
328
- type: string
329
- description: Applicant File Download
330
- readOnly: true
331
- required:
332
- - id
333
- - person_id
334
- - status
335
- - error
336
- - description
337
- - classification
338
- - year_applying_for
339
- - school_year
340
- - notes
341
- - download_url
342
- value_lists:
343
- type: array
344
- description: Present only with header `X-API-Value-Lists = include`
345
- readOnly: true
346
- items:
347
- type: object
348
- properties:
349
- fields:
350
- type: array
351
- description: An array of field names from `data` that this value list goes with
352
- items:
353
- type: string
354
- enum:
355
- - status
356
- - year_applying_for
357
- - school_year
358
- items:
359
- type: array
360
- description: An array of value list items whose `id` field matches the value in the response data
361
- items:
362
- type: object
363
- properties:
364
- id:
365
- type: string
366
- description:
367
- type: string
368
- category:
369
- type: integer
370
- sort_key:
371
- type: integer
372
- obsolete:
373
- type: boolean
374
- required:
375
- - id
376
- - description
377
- - sort_key
378
- categories:
379
- type: array
380
- description: 'An array of "category" objects, which allow you to partition the value list items according to their category field'
381
- items:
382
- type: object
383
- properties:
384
- id:
385
- type: integer
386
- description:
387
- type: string
388
- sort_key:
389
- type: integer
390
- required:
391
- - id
392
- - description
393
- - sort_key
394
- required:
395
- - fields
396
- - items
397
- - categories
398
- required:
399
- - data
400
- headers:
401
- X-API-Revision:
402
- required: true
403
- description: API Revision
404
- schema:
405
- type: string
406
- 4XX:
407
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
408
- content:
409
- application/json:
410
- schema:
411
- $ref: '#/components/schemas/error'
412
- 5XX:
413
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
414
- content:
415
- application/json:
416
- schema:
417
- $ref: '#/components/schemas/error'
418
- security:
419
- - access_token:
420
- - 'files:applicant_file:read'
421
- parameters:
422
- - name: id
423
- in: path
424
- description: File ID
425
- required: true
426
- schema:
427
- type: integer
428
- - $ref: '#/components/parameters/api_revision'
429
- '/ap_invoices/{invoice_id}/files':
430
- post:
431
- tags:
432
- - 'Finance: AP Invoice Files'
433
- summary: 'Create Finance: AP Invoice Files'
434
- operationId: create_finance_ap_invoice_files
435
- requestBody:
436
- content:
437
- application/json:
438
- schema:
439
- type: object
440
- properties:
441
- data:
442
- type: object
443
- properties:
444
- invoice_id:
445
- type: integer
446
- description: Record ID
447
- invoice_number:
448
- type: string
449
- description: Invoice Number
450
- maxLength: 30
451
- name:
452
- type: string
453
- description: Name
454
- maxLength: 1000
455
- id:
456
- type: integer
457
- description: File ID
458
- readOnly: true
459
- description:
460
- type: string
461
- description: Description (Text)
462
- maxLength: 1000
463
- notes:
464
- type: string
465
- description: Notes
466
- download_url:
467
- type: string
468
- description: File Download
469
- readOnly: true
470
- required:
471
- - invoice_number
472
- required:
473
- - data
474
- responses:
475
- '201':
476
- description: Created
477
- content:
478
- application/json:
479
- schema:
480
- type: object
481
- properties:
482
- data:
483
- type: object
484
- properties:
485
- id:
486
- type: integer
487
- description: File ID
488
- required:
489
- - id
490
- upload_url:
491
- type: string
492
- description: |
493
- - Make request using PUT method
494
- - Provide raw file in request body (not multipart/form-data)
495
- - URL accepts one upload only; reusing it is rejected
496
- - Expires after 5 minutes
497
- - Allowed file types: `text/csv`, `application/msword`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document`, `image/gif`, `image/jpeg`, `application/pdf`, `image/png`, `application/vnd.ms-powerpoint`, `application/vnd.openxmlformats-officedocument.presentationml.presentation`, `text/plain`, `application/vnd.ms-excel`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/zip`
498
- - Max file size: 100 MB
499
- required:
500
- - data
501
- - upload_url
502
- headers:
503
- X-API-Revision:
504
- required: true
505
- description: API Revision
506
- schema:
507
- type: string
508
- 4XX:
509
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
510
- content:
511
- application/json:
512
- schema:
513
- $ref: '#/components/schemas/error'
514
- 5XX:
515
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
516
- content:
517
- application/json:
518
- schema:
519
- $ref: '#/components/schemas/error'
520
- security:
521
- - access_token:
522
- - 'files:ap_invoices.files:create'
523
- parameters:
524
- - name: invoice_id
525
- in: path
526
- description: Record ID
527
- required: true
528
- schema:
529
- type: integer
530
- - $ref: '#/components/parameters/api_revision'
531
- get:
532
- tags:
533
- - 'Finance: AP Invoice Files'
534
- summary: 'List Finance: AP Invoice Files'
535
- operationId: list_finance_ap_invoice_files
536
- parameters:
537
- - $ref: '#/components/parameters/page_number'
538
- - $ref: '#/components/parameters/page_size'
539
- - $ref: '#/components/parameters/value_lists'
540
- responses:
541
- '200':
542
- description: OK
543
- content:
544
- application/json:
545
- schema:
546
- type: object
547
- properties:
548
- data:
549
- type: array
550
- items:
551
- type: object
552
- properties:
553
- invoice_id:
554
- type: integer
555
- description: Record ID
556
- invoice_number:
557
- type: string
558
- description: Invoice Number
559
- maxLength: 30
560
- name:
561
- type: string
562
- description: Name
563
- maxLength: 1000
564
- id:
565
- type: integer
566
- description: File ID
567
- readOnly: true
568
- description:
569
- type: string
570
- description: Description (Text)
571
- maxLength: 1000
572
- notes:
573
- type: string
574
- description: Notes
575
- download_url:
576
- type: string
577
- description: File Download
578
- readOnly: true
579
- required:
580
- - invoice_id
581
- - invoice_number
582
- - name
583
- - id
584
- - description
585
- - notes
586
- - download_url
587
- value_lists:
588
- type: array
589
- description: Present only with header `X-API-Value-Lists = include`
590
- readOnly: true
591
- items:
592
- type: object
593
- maxItems: 0
594
- required:
595
- - data
596
- headers:
597
- X-API-Revision:
598
- required: true
599
- description: API Revision
600
- schema:
601
- type: string
602
- 4XX:
603
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
604
- content:
605
- application/json:
606
- schema:
607
- $ref: '#/components/schemas/error'
608
- 5XX:
609
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
610
- content:
611
- application/json:
612
- schema:
613
- $ref: '#/components/schemas/error'
614
- security:
615
- - access_token:
616
- - 'files:ap_invoices.files:list'
617
- '/ap_invoices/{invoice_id}/files/{id}':
618
- delete:
619
- tags:
620
- - 'Finance: AP Invoice Files'
621
- summary: 'Delete Finance: AP Invoice Files'
622
- operationId: delete_finance_ap_invoice_files
623
- responses:
624
- '204':
625
- description: No Content
626
- headers:
627
- X-API-Revision:
628
- required: true
629
- description: API Revision
630
- schema:
631
- type: string
632
- 4XX:
633
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
634
- content:
635
- application/json:
636
- schema:
637
- $ref: '#/components/schemas/error'
638
- 5XX:
639
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
640
- content:
641
- application/json:
642
- schema:
643
- $ref: '#/components/schemas/error'
644
- security:
645
- - access_token:
646
- - 'files:ap_invoices.files:delete'
647
- parameters:
648
- - name: invoice_id
649
- in: path
650
- description: Record ID
651
- required: true
652
- schema:
653
- type: integer
654
- - name: id
655
- in: path
656
- description: File ID
657
- required: true
658
- schema:
659
- type: integer
660
- - $ref: '#/components/parameters/api_revision'
661
- get:
662
- tags:
663
- - 'Finance: AP Invoice Files'
664
- summary: 'Read Finance: AP Invoice Files'
665
- operationId: read_finance_ap_invoice_files
666
- parameters:
667
- - $ref: '#/components/parameters/value_lists'
668
- responses:
669
- '200':
670
- description: OK
671
- content:
672
- application/json:
673
- schema:
674
- type: object
675
- properties:
676
- data:
677
- type: object
678
- properties:
679
- invoice_id:
680
- type: integer
681
- description: Record ID
682
- invoice_number:
683
- type: string
684
- description: Invoice Number
685
- maxLength: 30
686
- name:
687
- type: string
688
- description: Name
689
- maxLength: 1000
690
- id:
691
- type: integer
692
- description: File ID
693
- readOnly: true
694
- description:
695
- type: string
696
- description: Description (Text)
697
- maxLength: 1000
698
- notes:
699
- type: string
700
- description: Notes
701
- download_url:
702
- type: string
703
- description: File Download
704
- readOnly: true
705
- required:
706
- - invoice_id
707
- - invoice_number
708
- - name
709
- - id
710
- - description
711
- - notes
712
- - download_url
713
- value_lists:
714
- type: array
715
- description: Present only with header `X-API-Value-Lists = include`
716
- readOnly: true
717
- items:
718
- type: object
719
- maxItems: 0
720
- required:
721
- - data
722
- headers:
723
- X-API-Revision:
724
- required: true
725
- description: API Revision
726
- schema:
727
- type: string
728
- 4XX:
729
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
730
- content:
731
- application/json:
732
- schema:
733
- $ref: '#/components/schemas/error'
734
- 5XX:
735
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
736
- content:
737
- application/json:
738
- schema:
739
- $ref: '#/components/schemas/error'
740
- security:
741
- - access_token:
742
- - 'files:ap_invoices.files:read'
743
- /person_photo:
744
- post:
745
- tags:
746
- - Person Photo
747
- summary: Create Person Photo
748
- operationId: create_person_photo
749
- requestBody:
750
- content:
751
- application/json:
752
- schema:
753
- type: object
754
- properties:
755
- data:
756
- type: object
757
- properties:
758
- id:
759
- type: integer
760
- description: File ID
761
- readOnly: true
762
- person_id:
763
- type: integer
764
- description: Person ID
765
- notes:
766
- type: string
767
- description: Notes
768
- required:
769
- - person_id
770
- required:
771
- - data
772
- responses:
773
- '201':
774
- description: Created
775
- content:
776
- application/json:
777
- schema:
778
- type: object
779
- properties:
780
- data:
781
- type: object
782
- properties:
783
- id:
784
- type: integer
785
- description: File ID
786
- required:
787
- - id
788
- upload_url:
789
- type: string
790
- description: |
791
- - Make request using PUT method
792
- - Provide raw file in request body (not multipart/form-data)
793
- - URL accepts one upload only; reusing it is rejected
794
- - Expires after 5 minutes
795
- - Allowed file types: `image/jpg`, `image/jpeg`, `image/png`, `image/gif`
796
- - Max file size: 2 MB
797
- required:
798
- - data
799
- - upload_url
800
- headers:
801
- X-API-Revision:
802
- required: true
803
- description: API Revision
804
- schema:
805
- type: string
806
- 4XX:
807
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
808
- content:
809
- application/json:
810
- schema:
811
- $ref: '#/components/schemas/error'
812
- 5XX:
813
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
814
- content:
815
- application/json:
816
- schema:
817
- $ref: '#/components/schemas/error'
818
- security:
819
- - access_token:
820
- - 'files:person_photo:create'
821
- parameters:
822
- - $ref: '#/components/parameters/api_revision'
823
- '/person_photo/{id}':
824
- get:
825
- tags:
826
- - Person Photo
827
- summary: Read Person Photo
828
- operationId: read_person_photo
829
- parameters:
830
- - $ref: '#/components/parameters/value_lists'
831
- responses:
832
- '200':
833
- description: OK
834
- content:
835
- application/json:
836
- schema:
837
- type: object
838
- properties:
839
- data:
840
- type: object
841
- properties:
842
- id:
843
- type: integer
844
- description: File ID
845
- readOnly: true
846
- person_id:
847
- type: integer
848
- description: Person ID
849
- status:
850
- type: integer
851
- description: API Upload Status
852
- error:
853
- type: string
854
- description: API Upload Error
855
- download_url:
856
- type: string
857
- description: |-
858
- Person Photo URL/W Expiration
859
-
860
- This URL is private and expires 24 hours after the API request is completed.
861
- readOnly: true
862
- notes:
863
- type: string
864
- description: Notes
865
- last_modified_date:
866
- type: string
867
- format: date-time
868
- description: Last Modified Date
869
- readOnly: true
870
- required:
871
- - id
872
- - person_id
873
- - status
874
- - error
875
- - download_url
876
- - notes
877
- - last_modified_date
878
- value_lists:
879
- type: array
880
- description: Present only with header `X-API-Value-Lists = include`
881
- readOnly: true
882
- items:
883
- type: object
884
- properties:
885
- fields:
886
- type: array
887
- description: An array of field names from `data` that this value list goes with
888
- items:
889
- type: string
890
- enum:
891
- - status
892
- items:
893
- type: array
894
- description: An array of value list items whose `id` field matches the value in the response data
895
- items:
896
- type: object
897
- properties:
898
- id:
899
- type: string
900
- description:
901
- type: string
902
- category:
903
- type: integer
904
- sort_key:
905
- type: integer
906
- obsolete:
907
- type: boolean
908
- required:
909
- - id
910
- - description
911
- - sort_key
912
- categories:
913
- type: array
914
- description: 'An array of "category" objects, which allow you to partition the value list items according to their category field'
915
- items:
916
- type: object
917
- properties:
918
- id:
919
- type: integer
920
- description:
921
- type: string
922
- sort_key:
923
- type: integer
924
- required:
925
- - id
926
- - description
927
- - sort_key
928
- required:
929
- - fields
930
- - items
931
- - categories
932
- required:
933
- - data
934
- headers:
935
- X-API-Revision:
936
- required: true
937
- description: API Revision
938
- schema:
939
- type: string
940
- 4XX:
941
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
942
- content:
943
- application/json:
944
- schema:
945
- $ref: '#/components/schemas/error'
946
- 5XX:
947
- description: '> Note: Be sure to check the HTTP response code for these errors as well'
948
- content:
949
- application/json:
950
- schema:
951
- $ref: '#/components/schemas/error'
952
- security:
953
- - access_token:
954
- - 'files:person_photo:read'
955
- parameters:
956
- - name: id
957
- in: path
958
- description: File ID
959
- required: true
960
- schema:
961
- type: integer
962
- - $ref: '#/components/parameters/api_revision'
963
- components:
964
- parameters:
965
- page_number:
966
- name: X-Page-Number
967
- in: header
968
- description: Page number
969
- schema:
970
- type: integer
971
- default: 1
972
- minimum: 1
973
- page_size:
974
- name: X-Page-Size
975
- in: header
976
- description: Number of records per page (for collection endpoints)
977
- schema:
978
- type: integer
979
- default: 100
980
- minimum: 1
981
- maximum: 1000
982
- value_lists:
983
- name: X-API-Value-Lists
984
- in: header
985
- description: Include Value Lists in response
986
- schema:
987
- type: string
988
- enum:
989
- - include
990
- api_revision:
991
- name: X-API-Revision
992
- in: header
993
- description: API Revision
994
- schema:
995
- type: string
996
- schemas:
997
- post:
998
- type: object
999
- properties:
1000
- data:
1001
- type: object
1002
- properties:
1003
- id:
1004
- type: integer
1005
- required:
1006
- - id
1007
- required:
1008
- - data
1009
- error:
1010
- type: object
1011
- description: 'HTTP response codes describe the error type. See here for a list of HTTP response codes and their meanings: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status'
1012
- properties:
1013
- error:
1014
- type: string
1015
- description: The description of the error
1016
- error_id:
1017
- type: string
1018
- description: A unique ID for this specific error. Please provide this error id when you ask for help with an error.
1019
- required:
1020
- - error
1021
- - error_id
1022
- securitySchemes:
1023
- access_token:
1024
- type: oauth2
1025
- flows:
1026
- clientCredentials:
1027
- tokenUrl: 'https://accounts.veracross.com/{school_route}/oauth/token'
1028
- scopes:
1029
- 'files:applicant_file:create': 'Create Admissions: Applicant Files'
1030
- 'files:applicant_file:list': 'List Admissions: Applicant Files'
1031
- 'files:applicant_file:read': 'Read Admissions: Applicant Files'
1032
- 'files:ap_invoices.files:create': 'Create Finance: AP Invoice Files'
1033
- 'files:ap_invoices.files:delete': 'Delete Finance: AP Invoice Files'
1034
- 'files:ap_invoices.files:list': 'List Finance: AP Invoice Files'
1035
- 'files:ap_invoices.files:read': 'Read Finance: AP Invoice Files'
1036
- 'files:person_photo:create': Create Person Photo
1037
- 'files:person_photo:read': Read Person Photo
1038
- tags:
1039
- - name: 'Admissions: Applicant Files'
1040
- - name: 'Finance: AP Invoice Files'
1041
- - name: Person Photo