| Required permission: | ReadRegistrationAvailability |
| POST | /registration/summary |
|---|
"use strict";
export class PersonSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,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?:string,is_student?:boolean,is_faculty?:boolean,is_vendor?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {?number} */
ubc_id;
/** @type {string} */
uuid;
/** @type {string} */
regent_login;
/** @type {string} */
first_name;
/** @type {string} */
preferred_name;
/** @type {string} */
middle_name;
/** @type {string} */
last_name;
/** @type {string} */
email;
/** @type {string} */
phone_home;
/** @type {string} */
phone_cell;
/** @type {string} */
phone_bus;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
code;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {?string} */
dob;
/** @type {boolean} */
is_student;
/** @type {boolean} */
is_faculty;
/** @type {boolean} */
is_vendor;
}
export class StudentAcademicCredentialSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,course_uuid?:string,course_name?:string,section_code?:string,section_id?:number,term?:string,reporting_term?:string,title?:string,amount?:number,is_audit?:boolean,is_pass_fail?:boolean,is_graded?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
course_uuid;
/** @type {string} */
course_name;
/** @type {string} */
section_code;
/** @type {?number} */
section_id;
/** @type {string} */
term;
/** @type {string} */
reporting_term;
/** @type {string} */
title;
/** @type {?number} */
amount;
/** @type {boolean} */
is_audit;
/** @type {boolean} */
is_pass_fail;
/** @type {boolean} */
is_graded;
}
export class StudentAcademicCredentialByReportingTermSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,reportingTerm?:string,onlineCreditsAttempted?:number,onlineAuditsAttempted?:number,studentAcademicCredentialSimpleResponse?:StudentAcademicCredentialSimpleResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
reportingTerm;
/** @type {number} */
onlineCreditsAttempted;
/** @type {number} */
onlineAuditsAttempted;
/** @type {StudentAcademicCredentialSimpleResponse[]} */
studentAcademicCredentialSimpleResponse;
}
export class RegistrationDocumentResponse {
/** @param {{uuid?:string,regent_id?:number,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?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {number} */
regent_id;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
gender;
/** @type {string} */
email;
/** @type {string} */
program;
/** @type {string} */
concentration;
/** @type {string} */
section_uuid;
/** @type {string} */
course_name;
/** @type {string} */
course_title;
/** @type {string} */
reporting_term;
/** @type {string} */
document_code;
/** @type {string} */
document_json;
/** @type {string} */
document_name;
/** @type {string} */
document_description;
/** @type {?string} */
added_date;
/** @type {?string} */
changed_date;
}
export class ProvisionalRegistrationResponse {
/** @param {{uuid?:string,regent_id?:number,student_name?:string,email?:string,section_uuid?:string,student_section_uuid?:string,course_name?:string,section_code?:string,title?:string,term?:string,amount?:number,is_audit?:boolean,is_waitlist?:boolean,is_missing_requisites?:boolean,is_other_restriction?:boolean,documents?:RegistrationDocumentResponse[],requested_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {?number} */
regent_id;
/** @type {string} */
student_name;
/** @type {string} */
email;
/** @type {string} */
section_uuid;
/** @type {string} */
student_section_uuid;
/** @type {string} */
course_name;
/** @type {string} */
section_code;
/** @type {string} */
title;
/** @type {string} */
term;
/** @type {number} */
amount;
/** @type {boolean} */
is_audit;
/** @type {boolean} */
is_waitlist;
/** @type {boolean} */
is_missing_requisites;
/** @type {boolean} */
is_other_restriction;
/** @type {RegistrationDocumentResponse[]} */
documents;
/** @type {string} */
requested_date;
}
export class ProvisionalRegistrationsForStudentResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,provisional_registrations?:ProvisionalRegistrationResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {ProvisionalRegistrationResponse[]} */
provisional_registrations;
}
export class RegistrationSummaryResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,is_missing_tax_number?:boolean,person?:PersonSimpleResponse,registrations?:StudentAcademicCredentialByReportingTermSimpleResponse[],provisional_registrations?:ProvisionalRegistrationsForStudentResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {boolean} */
is_missing_tax_number;
/** @type {PersonSimpleResponse} */
person;
/** @type {StudentAcademicCredentialByReportingTermSimpleResponse[]} */
registrations;
/** @type {ProvisionalRegistrationsForStudentResponse} */
provisional_registrations;
}
export class RegistrationSummaryRequest {
/** @param {{uuid?:string,from_this_term?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {string} */
from_this_term;
}
JavaScript RegistrationSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
Content-Length: length
{"uuid":"String","from_this_term":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}}