Skip to content

Commit b7cb567

Browse files
msheldont4emsheldont4e
authored
Merge pull request #3 from Tools4ever-NIM/msheldont4e-patch-1
Msheldont4e patch 1
2 parents c8c2e1b + 397c740 commit b7cb567

1 file changed

Lines changed: 189 additions & 17 deletions

File tree

‎Aeries.json‎

Lines changed: 189 additions & 17 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,6 +167,31 @@
167167
"query_parameters": {},
168168
"maxSessionCount": 20
169169
},
170+
"studentUpdate": {
171+
"method": "post",
172+
"call": {
173+
"mode": "normal",
174+
"path": "/api/v5/UpdateStudent/{StudentID}"
175+
},
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+
},
170195
"students_updateEmail": {
171196
"method": "post",
172197
"call": {
@@ -179,7 +204,6 @@
179204
"Columns": {
180205
"ColumnCode": "STE",
181206
"NewValue": "{StudentEmailAddress}"
182-
183207
}
184208
},
185209
"semantics": "update",
@@ -189,15 +213,39 @@
189213
"StudentID",
190214
"StudentEmailAddress"
191215
]
192-
}
216+
},
217+
"studentUpdateSchoolSupplemental": {
218+
"method": "post",
219+
"call": {
220+
"mode": "normal",
221+
"path": "/api/v5/UpdateSchoolSuppelmental/{SchoolCode}/{StudentNumber}"
222+
},
223+
"query_parameters": {},
224+
"body": {
225+
"_nim_merge_attributes_": false,
226+
"Columns": {
227+
"ColumnCode": "{ColumnCode}",
228+
"NewValue": "{NewValue}"
229+
}
230+
},
231+
"resource_allowance_default": "prohibited",
232+
"resource_prohibited": [
233+
],
234+
"resource_mandatory": [
235+
"SchoolCode",
236+
"StudentNumber",
237+
"ColumnCode",
238+
"NewValue"
239+
]
240+
}
193241
},
194242
"parameters": {},
195243
"key": "StudentID",
196244
"resources": {
197245
"StudentID": "number*",
198246
"SchoolCode": "number*",
199247
"StudentNumber": "number*",
200-
"StateStudentID": "0099500004",
248+
"StateStudentID": "string*",
201249
"LastName": "string*",
202250
"FirstName": "string*",
203251
"MiddleName": "string*",
@@ -270,12 +318,54 @@
270318
"NextGradeLevelShortDescription": "string",
271319
"NextGradeLevelLongDescription": "string*",
272320
"OldPermanentID": "number",
273-
"RecordsReleaseCode": "string"
321+
"RecordsReleaseCode": "string",
322+
"ColumnCode": "string",
323+
"NewValue": "string"
324+
}
325+
},
326+
"school_groups": {
327+
"operations": {
328+
"school_groupsList": {
329+
"method": "get",
330+
"call": {
331+
"mode": "iteration",
332+
"table": "schools",
333+
"iterator": "SchoolCode",
334+
"path": "/api/v5/schools/{iterator}/StudentGroups",
335+
"base": {
336+
"SchoolCode": "{iterator}"
337+
}
338+
},
339+
"processing_options": {
340+
"output_field": null
341+
},
342+
"query_parameters": {},
343+
"maxSessionCount": 20
344+
}
345+
},
346+
"parameters": {},
347+
"key": "GroupID",
348+
"resources": {
349+
"Description": "string*",
350+
"ExpirationDate": "date*",
351+
"GroupId": "number*",
352+
"IsCommunicationGroup": "boolean*",
353+
"Name": "string*",
354+
"Staff": [
355+
{
356+
"StaffId": "string*"
357+
}
358+
],
359+
"Students": [
360+
{
361+
"StudentId": "string*"
362+
}
363+
]
274364
}
275365
},
276366
"fees": {
277367
"operations": {
278-
"fees_get": {
368+
"feesList": {
279369
"method": "get",
280370
"call": {
281371
"mode": "iteration",
@@ -310,7 +400,7 @@
310400
},
311401
"student_classes": {
312402
"operations": {
313-
"student_classes_get": {
403+
"student_classesList": {
314404
"method": "get",
315405
"call": {
316406
"mode": "iteration",
@@ -339,7 +429,7 @@
339429
},
340430
"courses": {
341431
"operations": {
342-
"courses_get": {
432+
"coursesList": {
343433
"method": "get",
344434
"call": {
345435
"mode": "normal",
@@ -448,7 +538,7 @@
448538
},
449539
"sections": {
450540
"operations": {
451-
"sections_get": {
541+
"sectionsList": {
452542
"method": "get",
453543
"call": {
454544
"mode": "iteration",
@@ -551,7 +641,7 @@
551641
},
552642
"staff": {
553643
"operations": {
554-
"staff_get": {
644+
"staffList": {
555645
"method": "get",
556646
"call": {
557647
"mode": "normal",
@@ -561,7 +651,39 @@
561651
"output_field": null
562652
},
563653
"query_parameters": {}
564-
}
654+
},
655+
"staffCreate": {
656+
"method": "post",
657+
"call": {
658+
"mode": "normal",
659+
"path": "/api/v5/staff"
660+
},
661+
"query_parameters": {},
662+
"semantics": "create",
663+
"resource_allowance_default": "optional",
664+
"resource_prohibited": [
665+
"ID"
666+
],
667+
"resource_mandatory": [
668+
"FirstName",
669+
"LastName"
670+
]
671+
},
672+
"staffUpdate": {
673+
"method": "put",
674+
"call": {
675+
"mode": "normal",
676+
"path": "/api/v5/staff/{ID}"
677+
},
678+
"query_parameters": {},
679+
"semantics": "update",
680+
"resource_allowance_default": "optional",
681+
"resource_prohibited": [
682+
],
683+
"resource_mandatory": [
684+
"ID"
685+
]
686+
}
565687
},
566688
"parameters": {},
567689
"key": "ID",
@@ -621,7 +743,7 @@
621743
},
622744
"teachers": {
623745
"operations": {
624-
"teachers_get": {
746+
"teachersList": {
625747
"method": "get",
626748
"call": {
627749
"mode": "iteration",
@@ -667,7 +789,7 @@
667789
},
668790
"staff_assignments": {
669791
"operations": {
670-
"staff_assignments_get": {
792+
"staff_assignmentsList": {
671793
"method": "get",
672794
"call": {
673795
"mode": "iteration",
@@ -680,7 +802,57 @@
680802
},
681803
"query_parameters": {},
682804
"maxSessionCount": 20
683-
}
805+
},
806+
"staff_assignmentsCreate": {
807+
"method": "post",
808+
"call": {
809+
"mode": "normal",
810+
"path": "/api/v5/staff/{ID}/assignments"
811+
},
812+
"query_parameters": {},
813+
"semantics": "create",
814+
"resource_allowance_default": "optional",
815+
"resource_prohibited": [
816+
],
817+
"resource_mandatory": [
818+
"AssignmentType",
819+
"ID"
820+
]
821+
},
822+
"staff_assignmentsUpdate": {
823+
"method": "put",
824+
"call": {
825+
"mode": "normal",
826+
"path": "/api/v5/staff/{ID}/assignments/{AssignmentType}/{SequenceNumber}"
827+
},
828+
"query_parameters": {},
829+
"semantics": "create",
830+
"resource_allowance_default": "optional",
831+
"resource_prohibited": [
832+
],
833+
"resource_mandatory": [
834+
"ID",
835+
"SequenceNumber",
836+
"AssignmentType"
837+
]
838+
},
839+
"staff_assignmentsDelete": {
840+
"method": "delete",
841+
"call": {
842+
"mode": "normal",
843+
"path": "/api/v5/staff/{ID}/assignments/{AssignmentType}/{SequenceNumber}"
844+
},
845+
"query_parameters": {},
846+
"semantics": "delete",
847+
"resource_allowance_default": "optional",
848+
"resource_prohibited": [
849+
],
850+
"resource_mandatory": [
851+
"ID",
852+
"SequenceNumber",
853+
"AssignmentType"
854+
]
855+
}
684856
},
685857
"parameters": {},
686858
"key": "ID",
@@ -704,7 +876,7 @@
704876
},
705877
"student_enrollments": {
706878
"operations": {
707-
"students_enrollments_get": {
879+
"students_enrollmentsList": {
708880
"method": "get",
709881
"call": {
710882
"mode": "normal",

0 commit comments

Comments
 (0)