Required role: | REGISUserRole |
POST | /Academic/{uuid}/RegentDegrees |
---|
"use strict";
export class RegentDegreeResponse {
/** @param {{id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,graduation_month?:string,start_date?:string,end_date?:string,gpa?:number,academic_level?:string,commencement_date?:string,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
program_code;
/** @type {string} */
program_name;
/** @type {string} */
concentration_code;
/** @type {string} */
concentration_name;
/** @type {?string} */
graduation_month;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {?number} */
gpa;
/** @type {string} */
academic_level;
/** @type {?string} */
commencement_date;
/** @type {?string} */
added_date;
/** @type {string} */
added_by;
/** @type {?string} */
changed_date;
/** @type {string} */
changed_by;
/** @type {string} */
timestamp;
}
export class ProgramResponse {
/** @param {{responseStatus?:ResponseStatus,id?:number,program_code?:string,program_pretty_code?:string,program_long_name?:string,available_concentrations?:string,is_active?:boolean,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
id;
/** @type {string} */
program_code;
/** @type {string} */
program_pretty_code;
/** @type {string} */
program_long_name;
/** @type {string} */
available_concentrations;
/** @type {boolean} */
is_active;
/** @type {string} */
timestamp;
}
export class ConcentrationResponse {
/** @param {{responseStatus?:ResponseStatus,id?:number,concentration_code?:string,concentration_name?:string,is_active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
id;
/** @type {string} */
concentration_code;
/** @type {string} */
concentration_name;
/** @type {boolean} */
is_active;
}
export class CatalogResponse {
/** @param {{responseStatus?:ResponseStatus,id?:number,catalog_code?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
id;
/** @type {string} */
catalog_code;
}
export class RegentDegreesResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,regent_degrees?:RegentDegreeResponse[],valid_programs?:ProgramResponse[],valid_concentrations?:ConcentrationResponse[],valid_catalogs?:CatalogResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {RegentDegreeResponse[]} */
regent_degrees;
/** @type {ProgramResponse[]} */
valid_programs;
/** @type {ConcentrationResponse[]} */
valid_concentrations;
/** @type {CatalogResponse[]} */
valid_catalogs;
}
export class RegentDegreesRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript RegentDegreesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/{uuid}/RegentDegrees HTTP/1.1
Host: data.regent-college.edu
Accept: application/json
Content-Type: application/json
Content-Length: length
{"uuid":"String"}
HTTP/1.1 200 OK Content-Type: application/json 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","regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"valid_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}],"valid_concentrations":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"concentration_code":"String","concentration_name":"String","is_active":false}],"valid_catalogs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"catalog_code":"String"}]}