regis

<back to all web services

AddRegistrationsSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/{uuid}/Add/{reporting_term}/Submit
"use strict";
export class AddRegistrationWithBenefitRequest {
    /** @param {{student_section_uuid?:string,description?:string,amount?:number,charge?:number,is_audit?:boolean,benefit_id?:number,benefit_amount?:number,second_benefit_id?:number,second_benefit_amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    student_section_uuid;
    /** @type {string} */
    description;
    /** @type {number} */
    amount;
    /** @type {number} */
    charge;
    /** @type {boolean} */
    is_audit;
    /** @type {?number} */
    benefit_id;
    /** @type {?number} */
    benefit_amount;
    /** @type {?number} */
    second_benefit_id;
    /** @type {?number} */
    second_benefit_amount;
}
export class AddRegistrationsAdditionalChargeSubmitRequest {
    /** @param {{rate_id?:number,description?:string,charge?:number,credit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    rate_id;
    /** @type {string} */
    description;
    /** @type {number} */
    charge;
    /** @type {number} */
    credit;
}
export class AddRegistrationsSubmitRequest {
    /** @param {{transaction_uuid?:string,uuid?:string,reporting_term?:string,description?:string,email_student?:boolean,registrations?:AddRegistrationWithBenefitRequest[],additional_term_charges?:AddRegistrationsAdditionalChargeSubmitRequest[],authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    description;
    /** @type {boolean} */
    email_student;
    /** @type {AddRegistrationWithBenefitRequest[]} */
    registrations;
    /** @type {AddRegistrationsAdditionalChargeSubmitRequest[]} */
    additional_term_charges;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript AddRegistrationsSubmitRequest 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}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	transaction_uuid: String,
	uuid: String,
	reporting_term: String,
	description: String,
	email_student: False,
	registrations: 
	[
		{
			student_section_uuid: String,
			description: String,
			amount: 0,
			charge: 0,
			is_audit: False,
			benefit_id: 0,
			benefit_amount: 0,
			second_benefit_id: 0,
			second_benefit_amount: 0
		}
	],
	additional_term_charges: 
	[
		{
			rate_id: 0,
			description: String,
			charge: 0,
			credit: 0
		}
	],
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}