| Required permission: | ReadRegistrationAvailability |
| POST | /registration/summary |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class RegistrationSummaryRequest
{
var uuid:String? = null
var from_this_term:String? = null
}
open class RegistrationSummaryResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var uuid:String? = null
var is_missing_tax_number:Boolean? = null
var person:PersonSimpleResponse? = null
var registrations:ArrayList<StudentAcademicCredentialByReportingTermSimpleResponse> = ArrayList<StudentAcademicCredentialByReportingTermSimpleResponse>()
var provisional_registrations:ProvisionalRegistrationsForStudentResponse? = null
}
open class PersonSimpleResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var ubc_id:Int? = null
var uuid:String? = null
var regent_login:String? = null
var first_name:String? = null
var preferred_name:String? = null
var middle_name:String? = null
var last_name:String? = null
var email:String? = null
var phone_home:String? = null
var phone_cell:String? = null
var phone_bus:String? = null
var addr1:String? = null
var addr2:String? = null
var city:String? = null
var state:String? = null
var country:String? = null
var code:String? = null
var citizenship:String? = null
var citizenship_other:String? = null
var permanent_resident:String? = null
var dob:Date? = null
var is_student:Boolean? = null
var is_faculty:Boolean? = null
var is_vendor:Boolean? = null
}
open class StudentAcademicCredentialByReportingTermSimpleResponse
{
var responseStatus:ResponseStatus? = null
var reportingTerm:String? = null
var onlineCreditsAttempted:BigDecimal? = null
var onlineAuditsAttempted:BigDecimal? = null
var studentAcademicCredentialSimpleResponse:ArrayList<StudentAcademicCredentialSimpleResponse> = ArrayList<StudentAcademicCredentialSimpleResponse>()
}
open class StudentAcademicCredentialSimpleResponse
{
var responseStatus:ResponseStatus? = null
var course_uuid:String? = null
var course_name:String? = null
var section_code:String? = null
var section_id:Int? = null
var term:String? = null
var reporting_term:String? = null
var title:String? = null
var amount:BigDecimal? = null
var is_audit:Boolean? = null
var is_pass_fail:Boolean? = null
var is_graded:Boolean? = null
}
open class ProvisionalRegistrationsForStudentResponse
{
var responseStatus:ResponseStatus? = null
var regent_id:Int? = null
var uuid:String? = null
var provisional_registrations:ArrayList<ProvisionalRegistrationResponse> = ArrayList<ProvisionalRegistrationResponse>()
}
open class ProvisionalRegistrationResponse
{
var uuid:String? = null
var regent_id:Int? = null
var student_name:String? = null
var email:String? = null
var section_uuid:String? = null
var student_section_uuid:String? = null
var course_name:String? = null
var section_code:String? = null
var title:String? = null
var term:String? = null
var amount:BigDecimal? = null
var is_audit:Boolean? = null
var is_waitlist:Boolean? = null
var is_missing_requisites:Boolean? = null
var is_other_restriction:Boolean? = null
var documents:ArrayList<RegistrationDocumentResponse> = ArrayList<RegistrationDocumentResponse>()
var requested_date:Date? = null
}
open class RegistrationDocumentResponse
{
var uuid:String? = null
var regent_id:Int? = null
var first_name:String? = null
var last_name:String? = null
var gender:String? = null
var email:String? = null
var program:String? = null
var concentration:String? = null
var section_uuid:String? = null
var course_name:String? = null
var course_title:String? = null
var reporting_term:String? = null
var document_code:String? = null
var document_json:String? = null
var document_name:String? = null
var document_description:String? = null
var added_date:Date? = null
var changed_date:Date? = null
}
Kotlin RegistrationSummaryRequest 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 /registration/summary HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
from_this_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
uuid: String,
is_missing_tax_number: False,
person:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
ubc_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,
addr1: String,
addr2: String,
city: String,
state: String,
country: String,
code: String,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
dob: 0001-01-01,
is_student: False,
is_faculty: False,
is_vendor: False
},
registrations:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
reportingTerm: String,
onlineCreditsAttempted: 0,
onlineAuditsAttempted: 0,
studentAcademicCredentialSimpleResponse:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
course_uuid: String,
course_name: String,
section_code: String,
section_id: 0,
term: String,
reporting_term: String,
title: String,
amount: 0,
is_audit: False,
is_pass_fail: False,
is_graded: False
}
]
}
],
provisional_registrations:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
uuid: String,
provisional_registrations:
[
{
uuid: String,
regent_id: 0,
student_name: String,
email: String,
section_uuid: String,
student_section_uuid: String,
course_name: String,
section_code: String,
title: String,
term: String,
amount: 0,
is_audit: False,
is_waitlist: False,
is_missing_requisites: False,
is_other_restriction: False,
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
}
],
requested_date: 0001-01-01
}
]
}
}