Required role: | REGISUserRole |
POST | /Registration/{uuid}/Provisional |
---|
"use strict";
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 ProvisionalRegistrationsForStudentRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript ProvisionalRegistrationsForStudentRequest 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/{uuid}/Provisional HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: 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, 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 } ] }