regis

<back to all web services

AddRegistrationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}
"use strict";
export class InvoiceResponse {
    /** @param {{responseStatus?:ResponseStatus,invoiceUUID?:string,regent_id?:number,uuid?:string,reporting_term?:string,total_charges?:number,total_credits?:number,current_status?:string,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    invoiceUUID;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {?number} */
    total_charges;
    /** @type {?number} */
    total_credits;
    /** @type {string} */
    current_status;
    /** @type {string} */
    timestamp;
}
export class InvoiceItemResponse {
    /** @param {{responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,charge?:number,credit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    invoiceItemUUID;
    /** @type {number} */
    rate_id;
    /** @type {string} */
    rate_code;
    /** @type {string} */
    rate_description;
    /** @type {?number} */
    charge;
    /** @type {?number} */
    credit;
}
export class InstructorResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,regent_login?:string,preferred_name?:string,first_name?:string,last_name?:string,full_name?:string,email?:string,image_base64?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    full_name;
    /** @type {string} */
    email;
    /** @type {string} */
    image_base64;
}
export class DocumentResponse {
    /** @param {{code?:string,document_name?:string,document_description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    code;
    /** @type {string} */
    document_name;
    /** @type {string} */
    document_description;
}
export class SectionResponse {
    /** @param {{responseStatus?:ResponseStatus,secUUID?:string,course_name?:string,section_code?:string,course_title?:string,course_short_title?:string,course_description?:string,crosslist_description?:string,crosslist_course_name?:string,location_long_name?:string,room?:string,instructors?:InstructorResponse[],required_documents?:DocumentResponse[],start_date?:string,end_date?:string,first_meeting_date?:string,last_meeting_date?:string,meeting_days?:string,start_times?:string[],end_times?:string[],is_online_only?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,credit_amounts?:number[],audit_amounts?:number[],audits_short_name?:string,audits_long_name?:string,credits_short_name?:string,credits_long_name?:string,distance_ed_materials?:string,prerequisites?:string,corequisites?:string,capacity?:number,flat_fee_amount?:number,additional_fee_amount?:number,registered_students?:number,three_credit_plus?:number,two_credit?:number,one_credit?:number,three_audit_plus?:number,two_audit?:number,one_audit?:number,crosslist_registered_students?:number,grades_received?:number,crosslist_grades_received?:number,registration_start_date?:string,registration_end_date?:string,add_start_date?:string,add_end_date?:string,drop_start_date?:string,drop_end_date?:string,grading_end_date?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    secUUID;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    course_title;
    /** @type {string} */
    course_short_title;
    /** @type {string} */
    course_description;
    /** @type {string} */
    crosslist_description;
    /** @type {string} */
    crosslist_course_name;
    /** @type {string} */
    location_long_name;
    /** @type {string} */
    room;
    /** @type {InstructorResponse[]} */
    instructors;
    /** @type {DocumentResponse[]} */
    required_documents;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {?string} */
    first_meeting_date;
    /** @type {?string} */
    last_meeting_date;
    /** @type {string} */
    meeting_days;
    /** @type {string[]} */
    start_times;
    /** @type {string[]} */
    end_times;
    /** @type {boolean} */
    is_online_only;
    /** @type {boolean} */
    is_weekend;
    /** @type {boolean} */
    is_weekday;
    /** @type {boolean} */
    is_evening;
    /** @type {boolean} */
    is_waitlist;
    /** @type {boolean} */
    has_special_requirements;
    /** @type {string} */
    special_requirements;
    /** @type {boolean} */
    is_unlisted;
    /** @type {number[]} */
    credit_amounts;
    /** @type {number[]} */
    audit_amounts;
    /** @type {string} */
    audits_short_name;
    /** @type {string} */
    audits_long_name;
    /** @type {string} */
    credits_short_name;
    /** @type {string} */
    credits_long_name;
    /** @type {string} */
    distance_ed_materials;
    /** @type {string} */
    prerequisites;
    /** @type {string} */
    corequisites;
    /** @type {?number} */
    capacity;
    /** @type {?number} */
    flat_fee_amount;
    /** @type {?number} */
    additional_fee_amount;
    /** @type {number} */
    registered_students;
    /** @type {number} */
    three_credit_plus;
    /** @type {number} */
    two_credit;
    /** @type {number} */
    one_credit;
    /** @type {number} */
    three_audit_plus;
    /** @type {number} */
    two_audit;
    /** @type {number} */
    one_audit;
    /** @type {number} */
    crosslist_registered_students;
    /** @type {number} */
    grades_received;
    /** @type {number} */
    crosslist_grades_received;
    /** @type {?string} */
    registration_start_date;
    /** @type {?string} */
    registration_end_date;
    /** @type {?string} */
    add_start_date;
    /** @type {?string} */
    add_end_date;
    /** @type {?string} */
    drop_start_date;
    /** @type {?string} */
    drop_end_date;
    /** @type {?string} */
    grading_end_date;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    reporting_year;
    /** @type {string} */
    current_status;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    timestamp;
}
export class StudentSectionResponse extends SectionResponse {
    /** @param {{studentSectionUUID?:string,registered_amount?:number,is_provisional?:boolean,is_audit?:boolean,responseStatus?:ResponseStatus,secUUID?:string,course_name?:string,section_code?:string,course_title?:string,course_short_title?:string,course_description?:string,crosslist_description?:string,crosslist_course_name?:string,location_long_name?:string,room?:string,instructors?:InstructorResponse[],required_documents?:DocumentResponse[],start_date?:string,end_date?:string,first_meeting_date?:string,last_meeting_date?:string,meeting_days?:string,start_times?:string[],end_times?:string[],is_online_only?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,credit_amounts?:number[],audit_amounts?:number[],audits_short_name?:string,audits_long_name?:string,credits_short_name?:string,credits_long_name?:string,distance_ed_materials?:string,prerequisites?:string,corequisites?:string,capacity?:number,flat_fee_amount?:number,additional_fee_amount?:number,registered_students?:number,three_credit_plus?:number,two_credit?:number,one_credit?:number,three_audit_plus?:number,two_audit?:number,one_audit?:number,crosslist_registered_students?:number,grades_received?:number,crosslist_grades_received?:number,registration_start_date?:string,registration_end_date?:string,add_start_date?:string,add_end_date?:string,drop_start_date?:string,drop_end_date?:string,grading_end_date?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,timestamp?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    studentSectionUUID;
    /** @type {number} */
    registered_amount;
    /** @type {boolean} */
    is_provisional;
    /** @type {boolean} */
    is_audit;
}
export class StudentSectionInvoiceItemResponse extends InvoiceItemResponse {
    /** @param {{studentSection?:StudentSectionResponse,responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,charge?:number,credit?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {StudentSectionResponse} */
    studentSection;
}
export class InvoiceItemAdminResponse {
    /** @param {{responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,is_required?:boolean,is_optional?:boolean,charge?:number,credit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    invoiceItemUUID;
    /** @type {number} */
    rate_id;
    /** @type {string} */
    rate_code;
    /** @type {string} */
    rate_description;
    /** @type {boolean} */
    is_required;
    /** @type {boolean} */
    is_optional;
    /** @type {?number} */
    charge;
    /** @type {?number} */
    credit;
}
export class BenefitResponse {
    /** @param {{rate_id?:number,rate_code?:string,rate_description?:string,percentage_rate?:number,is_optional?:boolean,is_required?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    rate_id;
    /** @type {string} */
    rate_code;
    /** @type {string} */
    rate_description;
    /** @type {number} */
    percentage_rate;
    /** @type {boolean} */
    is_optional;
    /** @type {boolean} */
    is_required;
}
export class AddRegistrationsResponse extends InvoiceResponse {
    /** @param {{transaction_uuid?:string,studentSectionInvoiceItems?:StudentSectionInvoiceItemResponse[],sectionRates?:{ [index: string]: SectionRateWithAmountResponse[]; },creditTuitionRate?:InvoiceItemAdminResponse,auditTuitionRate?:InvoiceItemAdminResponse,studentAge?:number,studentAgeAtEarliestSectionStartDate?:number,isRegentGrad?:boolean,isOnlyUnclassified?:boolean,canRegisterForAuditInTerm?:boolean,canRegisterForCreditInTerm?:boolean,messages?:string[],currentTermAuditHours?:number,currentTermCreditHours?:number,totalCreditHours?:number,availableInvoiceItems?:InvoiceItemAdminResponse[],availableBenefits?:BenefitResponse[],responseStatus?:ResponseStatus,invoiceUUID?:string,regent_id?:number,uuid?:string,reporting_term?:string,total_charges?:number,total_credits?:number,current_status?:string,timestamp?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    transaction_uuid;
    /** @type {StudentSectionInvoiceItemResponse[]} */
    studentSectionInvoiceItems;
    /** @type {{ [index: string]: SectionRateWithAmountResponse[]; }} */
    sectionRates;
    /** @type {InvoiceItemAdminResponse} */
    creditTuitionRate;
    /** @type {InvoiceItemAdminResponse} */
    auditTuitionRate;
    /** @type {?number} */
    studentAge;
    /** @type {?number} */
    studentAgeAtEarliestSectionStartDate;
    /** @type {boolean} */
    isRegentGrad;
    /** @type {boolean} */
    isOnlyUnclassified;
    /** @type {boolean} */
    canRegisterForAuditInTerm;
    /** @type {boolean} */
    canRegisterForCreditInTerm;
    /** @type {string[]} */
    messages;
    /** @type {number} */
    currentTermAuditHours;
    /** @type {number} */
    currentTermCreditHours;
    /** @type {number} */
    totalCreditHours;
    /** @type {InvoiceItemAdminResponse[]} */
    availableInvoiceItems;
    /** @type {BenefitResponse[]} */
    availableBenefits;
}
export class AddRegistrationRequest {
    /** @param {{section_uuid?:string,amount?:number,is_audit?:boolean,is_provisional?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    section_uuid;
    /** @type {number} */
    amount;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_provisional;
}
export class AddRegistrationsRequest {
    /** @param {{uuid?:string,transaction_uuid?:string,reporting_term?:string,sections?:AddRegistrationRequest[],authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {AddRegistrationRequest[]} */
    sections;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript AddRegistrationsRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Registration/{uuid}/Add/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	transaction_uuid: String,
	reporting_term: String,
	sections: 
	[
		{
			section_uuid: String,
			amount: 0,
			is_audit: False,
			is_provisional: False
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	transaction_uuid: String,
	studentSectionInvoiceItems: 
	[
		{
			studentSection: 
			{
				studentSectionUUID: String,
				registered_amount: 0,
				is_provisional: False,
				is_audit: False,
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				secUUID: String,
				course_name: String,
				section_code: String,
				course_title: String,
				course_short_title: String,
				course_description: String,
				crosslist_description: String,
				crosslist_course_name: String,
				location_long_name: String,
				room: String,
				instructors: 
				[
					{
						responseStatus: 
						{
							errorCode: String,
							message: String,
							stackTrace: String,
							errors: 
							[
								{
									errorCode: String,
									fieldName: String,
									message: String,
									meta: 
									{
										String: String
									}
								}
							],
							meta: 
							{
								String: String
							}
						},
						regent_id: 0,
						regent_login: String,
						preferred_name: String,
						first_name: String,
						last_name: String,
						full_name: String,
						email: String,
						image_base64: String
					}
				],
				required_documents: 
				[
					{
						code: String,
						document_name: String,
						document_description: String
					}
				],
				start_date: 0001-01-01,
				end_date: 0001-01-01,
				first_meeting_date: 0001-01-01,
				last_meeting_date: 0001-01-01,
				meeting_days: String,
				start_times: 
				[
					String
				],
				end_times: 
				[
					String
				],
				is_online_only: False,
				is_weekend: False,
				is_weekday: False,
				is_evening: False,
				is_waitlist: False,
				has_special_requirements: False,
				special_requirements: String,
				is_unlisted: False,
				credit_amounts: 
				[
					0
				],
				audit_amounts: 
				[
					0
				],
				audits_short_name: String,
				audits_long_name: String,
				credits_short_name: String,
				credits_long_name: String,
				distance_ed_materials: String,
				prerequisites: String,
				corequisites: String,
				capacity: 0,
				flat_fee_amount: 0,
				additional_fee_amount: 0,
				registered_students: 0,
				three_credit_plus: 0,
				two_credit: 0,
				one_credit: 0,
				three_audit_plus: 0,
				two_audit: 0,
				one_audit: 0,
				crosslist_registered_students: 0,
				grades_received: 0,
				crosslist_grades_received: 0,
				registration_start_date: 0001-01-01,
				registration_end_date: 0001-01-01,
				add_start_date: 0001-01-01,
				add_end_date: 0001-01-01,
				drop_start_date: 0001-01-01,
				drop_end_date: 0001-01-01,
				grading_end_date: 0001-01-01,
				term: String,
				reporting_term: String,
				reporting_year: 0,
				current_status: String,
				added_by: String,
				added_date: 0001-01-01,
				changed_by: String,
				changed_date: 0001-01-01,
				timestamp: 0001-01-01
			},
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			invoiceItemUUID: String,
			rate_id: 0,
			rate_code: String,
			rate_description: String,
			charge: 0,
			credit: 0
		}
	],
	sectionRates: 
	{
		String: 
		[
			{
				rate_id: 0,
				charge: 0,
				credit: 0,
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				uuid: String,
				secUUID: String,
				section_id: 0,
				course_name: String,
				section_code: String,
				title: String,
				reporting_term: String,
				rate_code: String,
				rate_description: String,
				is_override_credit_rate: False,
				is_override_audit_rate: False
			}
		]
	},
	creditTuitionRate: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		invoiceItemUUID: String,
		rate_id: 0,
		rate_code: String,
		rate_description: String,
		is_required: False,
		is_optional: False,
		charge: 0,
		credit: 0
	},
	auditTuitionRate: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		invoiceItemUUID: String,
		rate_id: 0,
		rate_code: String,
		rate_description: String,
		is_required: False,
		is_optional: False,
		charge: 0,
		credit: 0
	},
	studentAge: 0,
	studentAgeAtEarliestSectionStartDate: 0,
	isRegentGrad: False,
	isOnlyUnclassified: False,
	canRegisterForAuditInTerm: False,
	canRegisterForCreditInTerm: False,
	messages: 
	[
		String
	],
	currentTermAuditHours: 0,
	currentTermCreditHours: 0,
	totalCreditHours: 0,
	availableInvoiceItems: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			invoiceItemUUID: String,
			rate_id: 0,
			rate_code: String,
			rate_description: String,
			is_required: False,
			is_optional: False,
			charge: 0,
			credit: 0
		}
	],
	availableBenefits: 
	[
		{
			rate_id: 0,
			rate_code: String,
			rate_description: String,
			percentage_rate: 0,
			is_optional: False,
			is_required: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	invoiceUUID: String,
	regent_id: 0,
	uuid: String,
	reporting_term: String,
	total_charges: 0,
	total_credits: 0,
	current_status: String,
	timestamp: 0001-01-01
}