lock
OPTIONS
api/myEdOnline/v1/Classes
Retrieve all active classes
EXPANDexpand_more
Request Information
Roles
- Vendor_MyEdOnline
URI Parameters
None.
Body Parameters
None.
EXPANDexpand_more
Response Information
Resource Description
list of classes and relevant students and staff
SchoolClassListName | Description | Type | Additional information |
---|---|---|---|
SchoolCode | string |
None. |
|
Classes | Collection of Class |
None. |
Response Formats
{ "SchoolCode": "sample string 1", "Classes": [ { "FileType": "sample string 1", "FileYear": "sample string 2", "CampusCode": "sample string 3", "ClassCode": "sample string 4", "ClassDescription": "sample string 5", "StudentList": [ { "ID": 1 }, { "ID": 1 } ], "StaffList": [ { "ID": 1 }, { "ID": 1 } ] }, { "FileType": "sample string 1", "FileYear": "sample string 2", "CampusCode": "sample string 3", "ClassCode": "sample string 4", "ClassDescription": "sample string 5", "StudentList": [ { "ID": 1 }, { "ID": 1 } ], "StaffList": [ { "ID": 1 }, { "ID": 1 } ] } ] }
<SchoolClassList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.MyEdOnline"> <Classes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Synergetic.Model.myEdOnline"> <d2p1:Class> <d2p1:CampusCode>sample string 3</d2p1:CampusCode> <d2p1:ClassCode>sample string 4</d2p1:ClassCode> <d2p1:ClassDescription>sample string 5</d2p1:ClassDescription> <d2p1:FileType>sample string 1</d2p1:FileType> <d2p1:FileYear>sample string 2</d2p1:FileYear> <d2p1:StaffList> <d2p1:ClassStaff> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStaff> <d2p1:ClassStaff> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStaff> </d2p1:StaffList> <d2p1:StudentList> <d2p1:ClassStudent> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStudent> <d2p1:ClassStudent> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStudent> </d2p1:StudentList> </d2p1:Class> <d2p1:Class> <d2p1:CampusCode>sample string 3</d2p1:CampusCode> <d2p1:ClassCode>sample string 4</d2p1:ClassCode> <d2p1:ClassDescription>sample string 5</d2p1:ClassDescription> <d2p1:FileType>sample string 1</d2p1:FileType> <d2p1:FileYear>sample string 2</d2p1:FileYear> <d2p1:StaffList> <d2p1:ClassStaff> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStaff> <d2p1:ClassStaff> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStaff> </d2p1:StaffList> <d2p1:StudentList> <d2p1:ClassStudent> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStudent> <d2p1:ClassStudent> <d2p1:ID>1</d2p1:ID> </d2p1:ClassStudent> </d2p1:StudentList> </d2p1:Class> </Classes> <SchoolCode>sample string 1</SchoolCode> </SchoolClassList>