regis

RegistrationInProgressSummaryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST	/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_uuid}

"use strict";
export class RegistrationDocumentResponse {
    /** @param {{uuid?:string,regent_id?:number,first_name?:string,last_name?:string,gender?:string,email?:string,program?:string,concentration?:string,section_uuid?:string,course_name?:string,course_title?:string,reporting_term?:string,document_code?:string,document_json?:string,document_name?:string,document_description?:string,added_date?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    gender;
    /** @type {string} */
    email;
    /** @type {string} */
    program;
    /** @type {string} */
    concentration;
    /** @type {string} */
    section_uuid;
    /** @type {string} */
    course_name;
    /** @type {string} */
    course_title;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    document_code;
    /** @type {string} */
    document_json;
    /** @type {string} */
    document_name;
    /** @type {string} */
    document_description;
    /** @type {?string} */
    added_date;
    /** @type {?string} */
    changed_date;
}
export class RegistrationInProgressSummaryResponse {
    /** @param {{responseStatus?:ResponseStatus,transaction_uuid?:string,regent_id?:number,uuid?:string,reporting_term?:string,numberOfStudentSections?:number,amountOwing?:number,mustPayBeforeRegistering?:boolean,requiredDocuments?:RegistrationDocumentResponse[],completedDocuments?:RegistrationDocumentResponse[],isLate?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    transaction_uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    numberOfStudentSections;
    /** @type {number} */
    amountOwing;
    /** @type {boolean} */
    mustPayBeforeRegistering;
    /** @type {RegistrationDocumentResponse[]} */
    requiredDocuments;
    /** @type {RegistrationDocumentResponse[]} */
    completedDocuments;
    /** @type {boolean} */
    isLate;
}
export class RegistrationInProgressSummaryRequest {
    /** @param {{uuid?:string,transaction_uuid?:string,reporting_term?:string,online_only?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {boolean} */
    online_only;
}

JavaScript RegistrationInProgressSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","online_only":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"first_name":"String","last_name":"String","gender":"String","email":"String","program":"String","concentration":"String","section_uuid":"String","course_name":"String","course_title":"String","reporting_term":"String","document_code":"String","document_json":"String","document_name":"String","document_description":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}