regis

<back to all web services

StudentTransferCredentialPackageUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}/Update/{equivalent_id}
"use strict";
export class StudentTransferCredentialUpdateRequest {
    /** @param {{uuid?:string,stran_uuid?:string,course_name?:string,title?:string,credit_value?:number,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    stran_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {number} */
    credit_value;
    /** @type {string} */
    authorizing_uuid;
}
export class StudentAcademicCredentialUpdateRequest {
    /** @param {{uuid?:string,stac_uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,location?:string,is_audio?:boolean,is_oncampus?:boolean,credit_value?:number,audit_value?:number,is_audit?:boolean,is_pass_fail?:boolean,grade?:string,is_grade_final?:boolean,gpa_credits?:number,grade_points?:number,academic_level?:string,printed_comments?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    stac_uuid;
    /** @type {?number} */
    section_id;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    subject;
    /** @type {?number} */
    course_level;
    /** @type {string} */
    title;
    /** @type {string} */
    location;
    /** @type {boolean} */
    is_audio;
    /** @type {boolean} */
    is_oncampus;
    /** @type {?number} */
    credit_value;
    /** @type {?number} */
    audit_value;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_pass_fail;
    /** @type {string} */
    grade;
    /** @type {boolean} */
    is_grade_final;
    /** @type {?number} */
    gpa_credits;
    /** @type {?number} */
    grade_points;
    /** @type {string} */
    academic_level;
    /** @type {string} */
    printed_comments;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {?number} */
    reporting_year;
    /** @type {string} */
    current_status;
    /** @type {string} */
    authorizing_uuid;
}
export class StudentTransferCredentialPackageUpdateRequest {
    /** @param {{uuid?:string,equivalent_id?:number,is_advanced_standing?:boolean,institution_id?:number,authorizing_uuid?:string,studentTransferCredentialUpdateRequest?:StudentTransferCredentialUpdateRequest[],studentAcademicCredentialUpdateRequest?:StudentAcademicCredentialUpdateRequest[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    equivalent_id;
    /** @type {boolean} */
    is_advanced_standing;
    /** @type {number} */
    institution_id;
    /** @type {string} */
    authorizing_uuid;
    /** @type {StudentTransferCredentialUpdateRequest[]} */
    studentTransferCredentialUpdateRequest;
    /** @type {StudentAcademicCredentialUpdateRequest[]} */
    studentAcademicCredentialUpdateRequest;
}

JavaScript StudentTransferCredentialPackageUpdateRequest 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 /StudentTransferCredentials/{uuid}/Update/{equivalent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	equivalent_id: 0,
	is_advanced_standing: False,
	institution_id: 0,
	authorizing_uuid: String,
	studentTransferCredentialUpdateRequest: 
	[
		{
			uuid: String,
			stran_uuid: String,
			course_name: String,
			title: String,
			credit_value: 0,
			authorizing_uuid: String
		}
	],
	studentAcademicCredentialUpdateRequest: 
	[
		{
			uuid: String,
			stac_uuid: String,
			section_id: 0,
			course_name: String,
			section_code: String,
			subject: String,
			course_level: 0,
			title: String,
			location: String,
			is_audio: False,
			is_oncampus: False,
			credit_value: 0,
			audit_value: 0,
			is_audit: False,
			is_pass_fail: False,
			grade: String,
			is_grade_final: False,
			gpa_credits: 0,
			grade_points: 0,
			academic_level: String,
			printed_comments: String,
			term: String,
			reporting_term: String,
			reporting_year: 0,
			current_status: String,
			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
	}
}