Skip to content

Commit 5c5cb26

Browse files
msheldont4emsheldont4e
authored
Update Aeries.json
1 parent c8c2e1b commit 5c5cb26

1 file changed

Lines changed: 179 additions & 30 deletions

File tree

‎Aeries.json‎

Lines changed: 179 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"crud_objects": {
55
"schools": {
66
"operations": {
7-
"schools_get": {
7+
"schoolsList": {
88
"method": "get",
99
"call": {
1010
"mode": "normal",
@@ -55,7 +55,7 @@
5555
},
5656
"contacts": {
5757
"operations": {
58-
"contacts_get": {
58+
"contactsList": {
5959
"method": "get",
6060
"call": {
6161
"mode": "iteration",
@@ -153,7 +153,7 @@
153153
},
154154
"students": {
155155
"operations": {
156-
"students_get": {
156+
"studentsList": {
157157
"method": "get",
158158
"call": {
159159
"mode": "iteration",
@@ -167,27 +167,53 @@
167167
"query_parameters": {},
168168
"maxSessionCount": 20
169169
},
170-
"students_updateEmail": {
170+
"studentUpdate": {
171171
"method": "post",
172172
"call": {
173-
"mode": "normal",
174-
"path": "/api/v5/UpdateSchoolSupplemental/{SchoolCode}/{StudentID}"
173+
"mode": "normal",
174+
"path": "/api/v5/UpdateStudent/{StudentID}"
175175
},
176-
"query_parameters": {
176+
"query_parameters": {},
177+
"semantics": "update",
178+
"resource_allowance_default": "optional",
179+
"resource_prohibited": [
180+
"MailingAddress",
181+
"MailingAddressCity",
182+
"MailingAddressState",
183+
"MailingAddressZipCode",
184+
"MailingAddressZipExt",
185+
"ResidenceAddress",
186+
"ResidenceAddressCity",
187+
"ResidenceAddressState",
188+
"ResidenceAddressZipCode",
189+
"ResidenceAddressZipExt"
190+
],
191+
"resource_mandatory": [
192+
"StudentID"
193+
]
194+
},
195+
"studentUpdateSchoolSupplemental": {
196+
"method": "post",
197+
"call": {
198+
"mode": "normal",
199+
"path": "/api/v5/UpdateSchoolSuppelmental/{SchoolCode}/{StudentNumber}"
177200
},
178-
"body":{
179-
"Columns": {
180-
"ColumnCode": "STE",
181-
"NewValue": "{StudentEmailAddress}"
182-
183-
}
201+
"query_parameters": {},
202+
"body": {
203+
"_nim_merge_attributes_": false,
204+
"Columns": {
205+
"ColumnCode": "{ColumnCode}",
206+
"NewValue": "{NewValue}"
207+
}
184208
},
185-
"semantics": "update",
186209
"resource_allowance_default": "prohibited",
210+
"resource_prohibited": [
211+
],
187212
"resource_mandatory": [
188213
"SchoolCode",
189-
"StudentID",
190-
"StudentEmailAddress"
214+
"StudentNumber",
215+
"ColumnCode",
216+
"NewValue"
191217
]
192218
}
193219
},
@@ -197,7 +223,7 @@
197223
"StudentID": "number*",
198224
"SchoolCode": "number*",
199225
"StudentNumber": "number*",
200-
"StateStudentID": "0099500004",
226+
"StateStudentID": "string*",
201227
"LastName": "string*",
202228
"FirstName": "string*",
203229
"MiddleName": "string*",
@@ -270,12 +296,54 @@
270296
"NextGradeLevelShortDescription": "string",
271297
"NextGradeLevelLongDescription": "string*",
272298
"OldPermanentID": "number",
273-
"RecordsReleaseCode": "string"
299+
"RecordsReleaseCode": "string",
300+
"ColumnCode": "string",
301+
"NewValue": "string"
302+
}
303+
},
304+
"school_groups": {
305+
"operations": {
306+
"school_groupsList": {
307+
"method": "get",
308+
"call": {
309+
"mode": "iteration",
310+
"table": "schools",
311+
"iterator": "SchoolCode",
312+
"path": "/api/v5/schools/{iterator}/StudentGroups",
313+
"base": {
314+
"SchoolCode": "{iterator}"
315+
}
316+
},
317+
"processing_options": {
318+
"output_field": null
319+
},
320+
"query_parameters": {},
321+
"maxSessionCount": 20
322+
}
323+
},
324+
"parameters": {},
325+
"key": "GroupID",
326+
"resources": {
327+
"Description": "string*",
328+
"ExpirationDate": "date*",
329+
"GroupId": "number*",
330+
"IsCommunicationGroup": "boolean*",
331+
"Name": "string*",
332+
"Staff": [
333+
{
334+
"StaffId": "string*"
335+
}
336+
],
337+
"Students": [
338+
{
339+
"StudentId": "string*"
340+
}
341+
]
274342
}
275343
},
276344
"fees": {
277345
"operations": {
278-
"fees_get": {
346+
"feesList": {
279347
"method": "get",
280348
"call": {
281349
"mode": "iteration",
@@ -310,7 +378,7 @@
310378
},
311379
"student_classes": {
312380
"operations": {
313-
"student_classes_get": {
381+
"student_classesList": {
314382
"method": "get",
315383
"call": {
316384
"mode": "iteration",
@@ -339,7 +407,7 @@
339407
},
340408
"courses": {
341409
"operations": {
342-
"courses_get": {
410+
"coursesList": {
343411
"method": "get",
344412
"call": {
345413
"mode": "normal",
@@ -448,7 +516,7 @@
448516
},
449517
"sections": {
450518
"operations": {
451-
"sections_get": {
519+
"sectionsList": {
452520
"method": "get",
453521
"call": {
454522
"mode": "iteration",
@@ -551,7 +619,7 @@
551619
},
552620
"staff": {
553621
"operations": {
554-
"staff_get": {
622+
"staffList": {
555623
"method": "get",
556624
"call": {
557625
"mode": "normal",
@@ -561,7 +629,39 @@
561629
"output_field": null
562630
},
563631
"query_parameters": {}
564-
}
632+
},
633+
"staffCreate": {
634+
"method": "post",
635+
"call": {
636+
"mode": "normal",
637+
"path": "/api/v5/staff"
638+
},
639+
"query_parameters": {},
640+
"semantics": "create",
641+
"resource_allowance_default": "optional",
642+
"resource_prohibited": [
643+
"ID"
644+
],
645+
"resource_mandatory": [
646+
"FirstName",
647+
"LastName"
648+
]
649+
},
650+
"staffUpdate": {
651+
"method": "put",
652+
"call": {
653+
"mode": "normal",
654+
"path": "/api/v5/staff/{ID}"
655+
},
656+
"query_parameters": {},
657+
"semantics": "update",
658+
"resource_allowance_default": "optional",
659+
"resource_prohibited": [
660+
],
661+
"resource_mandatory": [
662+
"ID"
663+
]
664+
}
565665
},
566666
"parameters": {},
567667
"key": "ID",
@@ -621,7 +721,7 @@
621721
},
622722
"teachers": {
623723
"operations": {
624-
"teachers_get": {
724+
"teachersList": {
625725
"method": "get",
626726
"call": {
627727
"mode": "iteration",
@@ -667,7 +767,7 @@
667767
},
668768
"staff_assignments": {
669769
"operations": {
670-
"staff_assignments_get": {
770+
"staff_assignmentsList": {
671771
"method": "get",
672772
"call": {
673773
"mode": "iteration",
@@ -680,7 +780,57 @@
680780
},
681781
"query_parameters": {},
682782
"maxSessionCount": 20
683-
}
783+
},
784+
"staff_assignmentsCreate": {
785+
"method": "post",
786+
"call": {
787+
"mode": "normal",
788+
"path": "/api/v5/staff/{ID}/assignments"
789+
},
790+
"query_parameters": {},
791+
"semantics": "create",
792+
"resource_allowance_default": "optional",
793+
"resource_prohibited": [
794+
],
795+
"resource_mandatory": [
796+
"AssignmentType",
797+
"ID"
798+
]
799+
},
800+
"staff_assignmentsUpdate": {
801+
"method": "put",
802+
"call": {
803+
"mode": "normal",
804+
"path": "/api/v5/staff/{ID}/assignments/{AssignmentType}/{SequenceNumber}"
805+
},
806+
"query_parameters": {},
807+
"semantics": "create",
808+
"resource_allowance_default": "optional",
809+
"resource_prohibited": [
810+
],
811+
"resource_mandatory": [
812+
"ID",
813+
"SequenceNumber",
814+
"AssignmentType"
815+
]
816+
},
817+
"staff_assignmentsDelete": {
818+
"method": "delete",
819+
"call": {
820+
"mode": "normal",
821+
"path": "/api/v5/staff/{ID}/assignments/{AssignmentType}/{SequenceNumber}"
822+
},
823+
"query_parameters": {},
824+
"semantics": "delete",
825+
"resource_allowance_default": "optional",
826+
"resource_prohibited": [
827+
],
828+
"resource_mandatory": [
829+
"ID",
830+
"SequenceNumber",
831+
"AssignmentType"
832+
]
833+
}
684834
},
685835
"parameters": {},
686836
"key": "ID",
@@ -704,7 +854,7 @@
704854
},
705855
"student_enrollments": {
706856
"operations": {
707-
"students_enrollments_get": {
857+
"students_enrollmentsList": {
708858
"method": "get",
709859
"call": {
710860
"mode": "normal",
@@ -722,7 +872,7 @@
722872
"resources": {
723873
"StudentID": "number*",
724874
"InterIntraDistrictStateCode": "string",
725-
"NonpublicSchoolStateCode": "string",
875+
"NonpublicSchoolStateCode": "stiring",
726876
"NextSchoolCode": "number",
727877
"ReportingSchoolCode": "number",
728878
"SchoolCode": "number*",
@@ -755,7 +905,6 @@
755905
"test_connection": {
756906
"url": "/api/v5/systeminfo"
757907
},
758-
"socket_timeout": 3600000,
759908
"accept": "application/json",
760909
"headers": {
761910
"AERIES-CERT": "{client_secret}"

0 commit comments

Comments
 (0)