regis

AcademicSummaryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/{uuid}/Summary

"use strict";
export class StudentProgramSimpleResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,program_id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,start_date?:string,end_date?:string,catalog?:string,is_active?:boolean,is_graduated?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {number} */
    program_id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_name;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    catalog;
    /** @type {boolean} */
    is_active;
    /** @type {boolean} */
    is_graduated;
}
export class AcademicSummaryResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,gpa?:number,student_programs?:StudentProgramSimpleResponse[],unofficial_undergraduate_degree_description?:string,messages?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {?number} */
    gpa;
    /** @type {StudentProgramSimpleResponse[]} */
    student_programs;
    /** @type {string} */
    unofficial_undergraduate_degree_description;
    /** @type {string[]} */
    messages;
}
export class AcademicSummaryRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript AcademicSummaryRequest 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

HTTP + JSON

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

POST /Academic/{uuid}/Summary 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","gpa":0,"student_programs":[{"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","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}],"unofficial_undergraduate_degree_description":"String","messages":["String"]}