regis

<back to all web services

StudentProgramRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentProgram
"use strict";
export class StudentProgramResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,id?:number,program_code?:string,concentration_code?:string,start_date?:string,end_date?:string,catalog?:string,current_status?:string,current_status_date?: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 {number} */
    id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    concentration_code;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {string} */
    catalog;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class StudentProgramRequest {
    /** @param {{uuid?:string,programId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {number} */
    programId;
}

JavaScript StudentProgramRequest 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 /StudentProgram HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","programId":0}
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"}},"uuid":"String","id":0,"program_code":"String","concentration_code":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","current_status":"String","current_status_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}