regis

<back to all web services

RegistrationSummaryRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/summary
RegistrationSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidbodystringNo
from_this_termbodystringNo
RegistrationSummaryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
is_missing_tax_numberformboolNo
personformPersonSimpleResponseNo
registrationsformList<StudentAcademicCredentialByReportingTermSimpleResponse>No
provisional_registrationsformProvisionalRegistrationsForStudentResponseNo
PersonSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
ubc_idformint?No
uuidformstringNo
regent_loginformstringNo
first_nameformstringNo
preferred_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
emailformstringNo
phone_homeformstringNo
phone_cellformstringNo
phone_busformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
citizenshipformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
dobformDateTime?No
is_studentformboolNo
is_facultyformboolNo
is_vendorformboolNo
StudentAcademicCredentialByReportingTermSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
reportingTermformstringNo
OnlineCreditsAttemptedformdecimalNo
OnlineAuditsAttemptedformdecimalNo
studentAcademicCredentialSimpleResponseformList<StudentAcademicCredentialSimpleResponse>No
StudentAcademicCredentialSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
course_uuidformstringNo
course_nameformstringNo
section_codeformstringNo
section_idformint?No
termformstringNo
reporting_termformstringNo
titleformstringNo
amountformdecimal?No
is_auditformboolNo
is_pass_failformboolNo
is_gradedformboolNo
ProvisionalRegistrationsForStudentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
provisional_registrationsformList<ProvisionalRegistrationResponse>No
ProvisionalRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformint?No
student_nameformstringNo
emailformstringNo
section_uuidformstringNo
student_section_uuidformstringNo
course_nameformstringNo
section_codeformstringNo
titleformstringNo
termformstringNo
amountformdecimalNo
is_auditformboolNo
is_waitlistformboolNo
is_missing_requisitesformboolNo
is_other_restrictionformboolNo
documentsformList<RegistrationDocumentResponse>No
requested_dateformDateTimeNo
RegistrationDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
uuidformstringNo
regent_idformintNo
first_nameformstringNo
last_nameformstringNo
genderformstringNo
emailformstringNo
programformstringNo
concentrationformstringNo
section_uuidformstringNo
course_nameformstringNo
course_titleformstringNo
reporting_termformstringNo
document_codeformstringNo
document_jsonformstringNo
document_nameformstringNo
document_descriptionformstringNo
added_dateformDateTime?No
changed_dateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","from_this_term":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","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-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"requested_date":"0001-01-01T00:00:00.0000000"}]}}