| Required role: | REGISUserRole |
| POST | /StudentTransferCredentials/{uuid} |
|---|
"use strict";
export class InstitutionResponse {
/** @param {{responseStatus?:ResponseStatus,institution_id?:number,institution_name?:string,institution_previous_names?:string,institution_other_names?:string,institution_type?:string,accreditation_status?:string,accreditation_status_notes?:string,related_institutions?:string[],accreditation_status_changed_date?:string,gpa_conversion?:string,credit_hour_conversion?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,zip?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
institution_id;
/** @type {string} */
institution_name;
/** @type {string} */
institution_previous_names;
/** @type {string} */
institution_other_names;
/** @type {string} */
institution_type;
/** @type {string} */
accreditation_status;
/** @type {string} */
accreditation_status_notes;
/** @type {string[]} */
related_institutions;
/** @type {?string} */
accreditation_status_changed_date;
/** @type {string} */
gpa_conversion;
/** @type {string} */
credit_hour_conversion;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
zip;
}
export class StudentAcademicCredentialResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,stac_uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,pretty_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,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @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} */
pretty_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} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class StudentTransferCredentialResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,stran_uuid?:string,course_name?:string,title?:string,credit_value?:number,is_advanced_standing?:boolean,equivalent_id?:number,institution_id?:number,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {string} */
stran_uuid;
/** @type {string} */
course_name;
/** @type {string} */
title;
/** @type {?number} */
credit_value;
/** @type {boolean} */
is_advanced_standing;
/** @type {number} */
equivalent_id;
/** @type {number} */
institution_id;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
}
export class StudentTransferCredentialPackageResponse {
/** @param {{responseStatus?:ResponseStatus,equivalent_id?:number,is_advanced_standing?:boolean,institution?:InstitutionResponse,studentAcademicCredentials?:StudentAcademicCredentialResponse[],studentTransferCredentials?:StudentTransferCredentialResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
equivalent_id;
/** @type {boolean} */
is_advanced_standing;
/** @type {InstitutionResponse} */
institution;
/** @type {StudentAcademicCredentialResponse[]} */
studentAcademicCredentials;
/** @type {StudentTransferCredentialResponse[]} */
studentTransferCredentials;
}
export class StudentTransferCredentialsResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,studentTransferCredentialPackage?:StudentTransferCredentialPackageResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {StudentTransferCredentialPackageResponse[]} */
studentTransferCredentialPackage;
}
export class StudentTransferCredentialsRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript StudentTransferCredentialsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /StudentTransferCredentials/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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","studentTransferCredentialPackage":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"equivalent_id":0,"is_advanced_standing":false,"institution":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"institution_id":0,"institution_name":"String","institution_previous_names":"String","institution_other_names":"String","institution_type":"String","accreditation_status":"String","accreditation_status_notes":"String","related_institutions":["String"],"accreditation_status_changed_date":"0001-01-01T00:00:00.0000000","gpa_conversion":"String","credit_hour_conversion":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","zip":"String"},"studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_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","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"studentTransferCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stran_uuid":"String","course_name":"String","title":"String","credit_value":0,"is_advanced_standing":false,"equivalent_id":0,"institution_id":0,"added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}]}]}