Required permission: | ReadClassRosters |
POST | /ClassRoster/{reporting_term} | ||
---|---|---|---|
POST | /ClassRoster/{reporting_term}/{section_uuid} |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Namespace Global
Namespace regis.ClassLibrary.Requests
Public Partial Class ClassRosterRequest
Public Overridable Property reporting_term As String
Public Overridable Property section_uuid As String
End Class
End Namespace
End Namespace
VB.NET ClassRosterRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /ClassRoster/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reporting_term: String,
section_uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length [ { course_name: String, section_uuid: String, section_code: String, course_title: String, room: String, start_date: 0001-01-01, end_date: 0001-01-01, first_meeting_date: 0001-01-01, last_meeting_date: 0001-01-01, meeting_days: String, start_times: String, end_times: String, capacity: 0, term: String, reporting_term: String, has_required_documents: False, instructors: [ { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, regent_login: String, preferred_name: String, first_name: String, last_name: String, full_name: String, email: String, image_base64: String } ], registrations: [ { regent_id: 0, uuid: String, regent_login: String, first_name: String, preferred_name: String, middle_name: String, last_name: String, email: String, phone_home: String, phone_cell: String, phone_bus: String, academic_program: String, academic_concentration: String, amount: 0, is_credit: False, is_audit: False, is_provisional: False, additional_instructors: [ { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, regent_login: String, preferred_name: String, first_name: String, last_name: String, full_name: String, email: String, image_base64: String } ], documents: [ { uuid: String, regent_id: 0, first_name: String, last_name: String, gender: String, email: String, program: String, concentration: String, section_uuid: String, course_name: String, course_title: String, reporting_term: String, document_code: String, document_json: String, document_name: String, document_description: String, added_date: 0001-01-01, changed_date: 0001-01-01 } ], date: 0001-01-01 } ] } ]