Required permission: | ReadRegistrationAvailability |
POST | /registration/recent |
---|
export class PersonSimpleResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public ubc_id?: number;
public uuid: string;
public regent_login: string;
public first_name: string;
public preferred_name: string;
public middle_name: string;
public last_name: string;
public email: string;
public phone_home: string;
public phone_cell: string;
public phone_bus: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public code: string;
public citizenship: string;
public citizenship_other: string;
public permanent_resident: string;
public dob?: string;
public is_student: boolean;
public is_faculty: boolean;
public is_vendor: boolean;
public constructor(init?: Partial<PersonSimpleResponse>) { (Object as any).assign(this, init); }
}
export class StudentAcademicCredentialSimpleResponse
{
public responseStatus: ResponseStatus;
public course_uuid: string;
public course_name: string;
public section_code: string;
public section_id?: number;
public term: string;
public reporting_term: string;
public title: string;
public amount?: number;
public is_audit: boolean;
public is_pass_fail: boolean;
public is_graded: boolean;
public constructor(init?: Partial<StudentAcademicCredentialSimpleResponse>) { (Object as any).assign(this, init); }
}
export class StudentAcademicCredentialByReportingTermSimpleResponse
{
public responseStatus: ResponseStatus;
public reportingTerm: string;
public onlineCreditsAttempted: number;
public onlineAuditsAttempted: number;
public studentAcademicCredentialSimpleResponse: StudentAcademicCredentialSimpleResponse[];
public constructor(init?: Partial<StudentAcademicCredentialByReportingTermSimpleResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationDocumentResponse
{
public uuid: string;
public regent_id: number;
public first_name: string;
public last_name: string;
public gender: string;
public email: string;
public program: string;
public concentration: string;
public section_uuid: string;
public course_name: string;
public course_title: string;
public reporting_term: string;
public document_code: string;
public document_json: string;
public document_name: string;
public document_description: string;
public added_date?: string;
public changed_date?: string;
public constructor(init?: Partial<RegistrationDocumentResponse>) { (Object as any).assign(this, init); }
}
export class ProvisionalRegistrationResponse
{
public uuid: string;
public regent_id?: number;
public student_name: string;
public email: string;
public section_uuid: string;
public student_section_uuid: string;
public course_name: string;
public section_code: string;
public title: string;
public term: string;
public amount: number;
public is_audit: boolean;
public is_waitlist: boolean;
public is_missing_requisites: boolean;
public is_other_restriction: boolean;
public documents: RegistrationDocumentResponse[];
public requested_date: string;
public constructor(init?: Partial<ProvisionalRegistrationResponse>) { (Object as any).assign(this, init); }
}
export class ProvisionalRegistrationsForStudentResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public provisional_registrations: ProvisionalRegistrationResponse[];
public constructor(init?: Partial<ProvisionalRegistrationsForStudentResponse>) { (Object as any).assign(this, init); }
}
export class RegistrationSummaryResponse
{
public responseStatus: ResponseStatus;
public regent_id: number;
public uuid: string;
public is_missing_tax_number: boolean;
public person: PersonSimpleResponse;
public registrations: StudentAcademicCredentialByReportingTermSimpleResponse[];
public provisional_registrations: ProvisionalRegistrationsForStudentResponse;
public constructor(init?: Partial<RegistrationSummaryResponse>) { (Object as any).assign(this, init); }
}
export class RecentRegistrationRequest
{
public uuid: string;
public from_this_term: string;
public constructor(init?: Partial<RecentRegistrationRequest>) { (Object as any).assign(this, init); }
}
TypeScript RecentRegistrationRequest 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/recent 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 } ] } }